Class ListItemRouter

The list item router for the Guilded REST API.

Example

new ListItemRouter(rest);

Hierarchy

BaseRouter
- ListItemRouter

Index

Constructors

constructor

new ListItemRouter(rest: RESTManager): ListItemRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns ListItemRouter
Inherited from BaseRouter.constructor
- Defined in rest/src/routers/BaseRouter.ts:9

Properties

`Readonly` rest

rest: RESTManager

The REST API manager the router belongs to.

Methods

complete

complete(channelId: string, listItemId: string): Promise<void>
Complete a list item on Guilded.

Example
```
listItems.complete('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- listItemId: string
  
  The ID of the list item to complete.
Returns Promise<void>
- Defined in rest/src/routers/ListItemRouter.ts:95

create

create(channelId: string, message: string, note?: string): Promise<APIListItem>
Create a list item on Guilded.

Returns
The created list item.

Example
```
listItems.create('abc', 'Random item');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- message: string
  
  The message of the list item.
- Optional note: string
  
  The note of the list item.
Returns Promise<APIListItem>
- Defined in rest/src/routers/ListItemRouter.ts:54

delete

delete(channelId: string, listItemId: string): Promise<void>
Delete a list item from Guilded.

Example
```
listItems.delete('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- listItemId: string
  
  The ID of the list item to delete.
Returns Promise<void>
- Defined in rest/src/routers/ListItemRouter.ts:85

edit

edit(channelId: string, listItemId: string, message: string, note?: string): Promise<APIListItem>
Edit a list item on Guilded.

Returns
The edited list item.

Example
```
listItems.edit('abc', 'abc', 'Random item');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- listItemId: string
  
  The ID of the list item to edit.
- message: string
  
  The message of theb list item.
- Optional note: string
  
  The note of the list item.
Returns Promise<APIListItem>
- Defined in rest/src/routers/ListItemRouter.ts:71

fetch

fetch(channelId: string, listItemId: string): Promise<APIListItem>
Fetch a list item from Guilded.

Returns
The fetched list item.

Example
```
listItems.fetch('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- listItemId: string
  
  The ID of the list item to fetch.
Returns Promise<APIListItem>
- Defined in rest/src/routers/ListItemRouter.ts:16
fetch(channelId: string): Promise<APIListItem[]>
Fetch list items from Guilded.

Returns
The fetched list items.

Example
```
listItems.fetch('abc');
```
Parameters
- channelId: string
  
  The ID of the channel the list items belong to.
Returns Promise<APIListItem[]>
- Defined in rest/src/routers/ListItemRouter.ts:23

uncomplete

uncomplete(channelId: string, listItemId: string): Promise<void>
Uncomplete a list item on Guilded.

Example
```
listItems.uncomplete('abc', 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the list item belongs to.
- listItemId: string
  
  The ID of the list item to uncomplete.
Returns Promise<void>
- Defined in rest/src/routers/ListItemRouter.ts:105

Class ListItemRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns ListItemRouter

Properties

Readonly rest

Methods

complete

Example

Parameters

channelId: string

listItemId: string

Returns Promise<void>

create

Returns

Example

Parameters

channelId: string

message: string

Optional note: string

Returns Promise<APIListItem>

delete

Example

Parameters

channelId: string

listItemId: string

Returns Promise<void>

edit

Returns

Example

Parameters

channelId: string

listItemId: string

message: string

Optional note: string

Returns Promise<APIListItem>

fetch

Returns

Example

Parameters

channelId: string

listItemId: string

Returns Promise<APIListItem>

Returns

Example

Parameters

channelId: string

Returns Promise<APIListItem[]>

uncomplete

Example

Parameters

channelId: string

listItemId: string

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` rest

`Optional` note: string

`Optional` note: string