Class ListItem

Represents an item of a "Lists" channel.

Hierarchy

Base<string>
- ListItem

Index

Constructors

Constructors

constructor

new ListItem(data, client): ListItem
Parameters
- data: APIListItem
  
  raw data.
- client: Client
  
  client.
Returns ListItem
Overrides Base.constructor
- Defined in lib/structures/ListItem.ts:41

Properties

_data

_data: APIListItem

Raw data

channelID

channelID: string

ID of the 'docs' channel.

client

client: Client

Bot's client.

completedAt

completedAt: null | Date

When the list item was marked as "completed".

completedBy

completedBy: null | string

ID of the member that completed the item, if completed.

content

content: string

Content of the doc

createdAt

createdAt: null | Date

When the item was created.

editedTimestamp

editedTimestamp: null | Date

Timestamp at which the item was updated.

guildID

guildID: string

Guild id

id

id: string

Item ID

memberID

memberID: string

ID of the member who created the doc.

mentions

mentions: null | APIMentions

parentListItemID

parentListItemID: null | string

The ID of the parent list item if this list item is nested

updatedBy

updatedBy: null | string

ID of the member who updated the doc. (if updated)

webhookID

webhookID: null | string

ID of the webhook that created the list item (if it was created by a webhook)

Accessors

member

get member(): Member | Promise<Member>
Retrieve the member who executed this action.

Note: If the item has been edited, the updatedBy id will be used to get you the member.

Returns Member | Promise<Member>
- Defined in lib/structures/ListItem.ts:137

note

get note(): null | ListItemNoteTypes
Returns null | ListItemNoteTypes
- Defined in lib/structures/ListItem.ts:122

Methods

complete

complete(): Promise<void>
Set this item as "complete".

Returns Promise<void>
- Defined in lib/structures/ListItem.ts:154

delete

delete(): Promise<void>
Delete this item.

Returns Promise<void>
- Defined in lib/structures/ListItem.ts:149

edit

edit(options?): Promise<ListItem>
Edit this item.
Parameters
- Optional options: {
      content?: string;
      note?: {
          content: string;
      };
  }
  
  Edit options.
  - Optional content?: string
  - Optional note?: {
    content: string;
    }
    - content: string
      
      The note of the list item
Returns Promise<ListItem>
- Defined in lib/structures/ListItem.ts:144

toJSON

toJSON(): JSONListItem
Returns JSONListItem
Overrides Base.toJSON
- Defined in lib/structures/ListItem.ts:59

uncomplete

uncomplete(): Promise<void>
Set this item as "uncomplete".

Returns Promise<void>
- Defined in lib/structures/ListItem.ts:159

Class ListItem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: APIListItem

client: Client

Returns ListItem

Properties

_data

channelID

client

completedAt

completedBy

content

createdAt

editedTimestamp

guildID

id

memberID

mentions

parentListItemID

updatedBy

webhookID

Accessors

member

Returns Member | Promise<Member>

note

Returns null | ListItemNoteTypes

Methods

complete

Returns Promise<void>

delete

Returns Promise<void>

edit

Parameters

Optional options: { content?: string; note?: { content: string; }; }

Optional content?: string

Optional note?: { content: string; }

content: string

Returns Promise<ListItem>

toJSON

Returns JSONListItem

uncomplete

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` options: {
content?: string;
note?: {
content: string;
};
}

`Optional` content?: string

`Optional` note?: {
content: string;
}