Class ListItem

Represents a list item on Guilded.

Example

new ListItem(channel, rawItem);

Hierarchy

Base
- ListItem

Index

Constructors

constructor

new ListItem(channel: ListChannel, raw: APIListItem | APIListItemSummary, cache?: boolean): ListItem
Parameters
- channel: ListChannel
  
  The list channel the item belongs to.
- raw: APIListItem | APIListItemSummary
  
  The raw data of the list item.
- Optional cache: boolean
  
  Whether to cache the list item.
Returns ListItem
Overrides Base.constructor
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:44

Properties

`Readonly` channel

channel: ListChannel

`Readonly` channelId

channelId: string

The ID of the channel the list item belongs to.

`Readonly` client

client: Client

`Optional` `Readonly` completedAt

completedAt?: Date

The date the list item was completed.

`Optional` `Readonly` completedBy

completedBy?: string

The ID of the user that completed the list item.

`Readonly` createdAt

createdAt: Date

The date the list item was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the list item.

`Optional` `Readonly` createdByWebhookId

createdByWebhookId?: string

The ID of the webhook that created the list item.

`Optional` `Readonly` editedAt

editedAt?: Date

The date the list item was edited.

`Optional` `Readonly` editedBy

editedBy?: string

The ID of the user that edited the list item.

`Readonly` id

id: string

`Optional` `Readonly` mentions

mentions?: APIMentions

The mentions of the list item.

`Readonly` message

message: string

The message of the list item.

`Optional` `Readonly` note

note?: ListItemNote

The note of the list item.

`Optional` `Readonly` parentId

parentId?: string

The ID of the list item the list item belongs to.

`Readonly` raw

raw: APIListItem | APIListItemSummary

`Readonly` serverId

serverId: string

The ID of the server the list item belongs to.

Accessors

author

get author(): undefined | ServerMember
The server member that created the list item.

Returns undefined | ServerMember
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:52

authorId

get authorId(): string
The ID of the user that created the list item.

Returns string
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:56

completedTimestamp

get completedTimestamp(): undefined | number
The timestamp the list item was completed.

Returns undefined | number
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:64

completer

get completer(): undefined | ServerMember
The server member that completed the list item.

Returns undefined | ServerMember
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:66

createdTimestamp

get createdTimestamp(): number
The timestamp the list item was created.

Returns number
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:50

editedTimestamp

get editedTimestamp(): undefined | number
The timestamp the list item was edited.

Returns undefined | number
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:58

editor

get editor(): undefined | ServerMember
The server member that edited the list item.

Returns undefined | ServerMember
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:60

isCached

get isCached(): boolean
Whether the list item is cached.

Returns boolean
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:46

isCompleted

get isCompleted(): boolean
Whether the list item is completed.

Returns boolean
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:68

isEditable

get isEditable(): boolean
Whether the list item is editable.

Returns boolean
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:70

parent

get parent(): undefined | ListItem
The list item the list item belongs to.

Returns undefined | ListItem
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:62

server

get server(): undefined | Server
The server the list item belongs to.

Returns undefined | Server
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:48

webhook

get webhook(): undefined | Webhook
The webhook that created the list item.

Returns undefined | Webhook
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:54

Methods

complete

complete(): Promise<ListItem>
Complete the list item.

Returns
The completed list item.

Example
```
listItem.complete();
```
Returns Promise<ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:139

edit

edit(message: string, note?: string): Promise<ListItem>
Edit the list item.

Returns
The edited list item.

Example
```
listItem.edit('Hello World!');
```
Parameters
- message: string
  
  The message of the list item.
- Optional note: string
  
  The note of the list item.
Returns Promise<ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:127

fetch

fetch(options?: FetchOptions): Promise<ListItem>
Fetch the list item.

Returns
The fetched list item.

Example
```
listItem.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the list item with.
Returns Promise<ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:77

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
Fetch the server member that created the list item.

Returns
The fetched server member.

Example
```
listItem.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:91

fetchCompleter

fetchCompleter(options?: FetchOptions): Promise<undefined | ServerMember>
Fetch the server member that completed the list item.

Returns
The fetched server member.

Example
```
listItem.fetchCompleter();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<undefined | ServerMember>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:119

fetchEditor

fetchEditor(options?: FetchOptions): Promise<undefined | ServerMember>
Fetch the server member that edited the list item.

Returns
The fetched server member.

Example
```
listItem.fetchEditor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<undefined | ServerMember>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:105

fetchParent

fetchParent(options?: FetchOptions): Promise<undefined | ListItem>
Fetch the list item the list item belongs to.

Returns
The fetched list item.

Example
```
listItem.fetchParent();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the list item with.
Returns Promise<undefined | ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:112

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
Fetch the server the list item belongs to.

Returns
The fetched server.

Example
```
listItem.fetchServer();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server with.
Returns Promise<Server>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:84

fetchWebhook

fetchWebhook(options?: FetchOptions): undefined | Promise<Webhook>
Fetch the webhook that created the list item.

Returns
The fetched webhook.

Example
```
listItem.fetchWebhook();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the webhook with.
Returns undefined | Promise<Webhook>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:98

remove

remove(): Promise<ListItem>
Remove the list item.

Returns
The removed list item.

Example
```
listItem.remove();
```
Returns Promise<ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:133

uncomplete

uncomplete(): Promise<ListItem>
Uncomplete the list item.

Returns
The uncompleted list item.

Example
```
listItem.uncomplete();
```
Returns Promise<ListItem>
- Defined in guilded.ts/dist/structures/listItem/ListItem.d.ts:145

Class ListItem

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: ListChannel

raw: APIListItem | APIListItemSummary

Optional cache: boolean

Returns ListItem

Properties

Readonly channel

Readonly channelId

Readonly client

Optional Readonly completedAt

Optional Readonly completedBy

Readonly createdAt

Readonly createdBy

Optional Readonly createdByWebhookId

Optional Readonly editedAt

Optional Readonly editedBy

Readonly id

Optional Readonly mentions

Readonly message

Optional Readonly note

Optional Readonly parentId

Readonly raw

Readonly serverId

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

completedTimestamp

Returns undefined | number

completer

Returns undefined | ServerMember

createdTimestamp

Returns number

editedTimestamp

Returns undefined | number

editor

Returns undefined | ServerMember

isCached

Returns boolean

isCompleted

Returns boolean

isEditable

Returns boolean

parent

Returns undefined | ListItem

server

Returns undefined | Server

webhook

Returns undefined | Webhook

Methods

complete

Returns

Example

Returns Promise<ListItem>

edit

Returns

Example

Parameters

message: string

Optional note: string

Returns Promise<ListItem>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ListItem>

fetchAuthor

Returns

`Optional` cache: boolean

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Optional` `Readonly` completedAt

`Optional` `Readonly` completedBy

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` createdByWebhookId

`Optional` `Readonly` editedAt

`Optional` `Readonly` editedBy

`Readonly` id

`Optional` `Readonly` mentions

`Readonly` message

`Optional` `Readonly` note

`Optional` `Readonly` parentId

`Readonly` raw

`Readonly` serverId

`Optional` note: string

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions