Class ListItem

constructor

• new ListItem(data, client): ListItem

• Parameters

  • data: {
        channelId: string;
        completedAt?: string;
        completedBy?: string;
        createdAt: string;
        createdBy: string;
        createdByWebhookId?: string;
        groupId: string;
        id: string;
        mentions?: {
            channels?: {
                id: string;
            }[];
            everyone?: boolean;
            here?: boolean;
            roles?: {
                id: number;
            }[];
            users?: {
                id: string;
            }[];
        };
        message: string;
        note?: {
            content: string;
            createdAt: string;
            createdBy: string;
            mentions?: {
                channels?: {
                    id: string;
                }[];
                everyone?: boolean;
                here?: boolean;
                roles?: {
                    id: number;
                }[];
                users?: {
                    id: string;
                }[];
            };
            updatedAt?: string;
            updatedBy?: string;
        };
        parentListItemId?: string;
        serverId: string;
        updatedAt?: string;
        updatedBy?: string;
    }

    raw data.

    • channelId: string

      Channel ID Format: uuid

      Description

      The ID of the channel

    • OptionalcompletedAt?: string

      Completed at Format: date-time

      Description

      The ISO 8601 timestamp that the list item was completed at

    • OptionalcompletedBy?: string

      Completed by

      Description

      The ID of the user who completed this list item

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the list item was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this list item (Note: If this event has createdByWebhookId present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)

    • OptionalcreatedByWebhookId?: string

      Created by Webhook ID

      Description

      The ID of the webhook who created this list item, if it was created by a webhook

    • groupId: string

      Group ID

      Description

      The ID of the group

    • id: string

      Format: uuid

      Description

      The ID of the list item

    • Optionalmentions?: {
          channels?: {
              id: string;
          }[];
          everyone?: boolean;
          here?: boolean;
          roles?: {
              id: number;
          }[];
          users?: {
              id: string;
          }[];
      }

      • Optionalchannels?: {
            id: string;
        }[]

        Channels

        Description

        Info on mentioned channels

      • Optionaleveryone?: boolean

        Everyone

        Description

        If

        Everyone

        was mentioned

      • Optionalhere?: boolean

        Here

        Description

        If

        Here

        was mentioned

      • Optionalroles?: {
            id: number;
        }[]

        Roles

        Description

        Info on mentioned roles

      • Optionalusers?: {
            id: string;
        }[]

        Users

        Description

        Info on mentioned users

    • message: string

      Message Format: list item markdown

      Description

      The message of the list item

    • Optionalnote?: {
          content: string;
          createdAt: string;
          createdBy: string;
          mentions?: {
              channels?: {
                  id: string;
              }[];
              everyone?: boolean;
              here?: boolean;
              roles?: {
                  id: number;
              }[];
              users?: {
                  id: string;
              }[];
          };
          updatedAt?: string;
          updatedBy?: string;
      }

      • content: string

        Note Format: long-form markdown

        Description

        The note of the list item

      • createdAt: string

        Created at Format: date-time

        Description

        The ISO 8601 timestamp that the note was created at. If this field is populated, then there's a note associated with the list item

      • createdBy: string

        Created by

        Description

        The ID of the user who created this note

      • Optionalmentions?: {
            channels?: {
                id: string;
            }[];
            everyone?: boolean;
            here?: boolean;
            roles?: {
                id: number;
            }[];
            users?: {
                id: string;
            }[];
        }

        • Optionalchannels?: {
              id: string;
          }[]

          Channels

          Description

          Info on mentioned channels

        • Optionaleveryone?: boolean

          Everyone

          Description

          If

          Everyone

          was mentioned

        • Optionalhere?: boolean

          Here

          Description

          If

          Here

          was mentioned

        • Optionalroles?: {
              id: number;
          }[]

          Roles

          Description

          Info on mentioned roles

        • Optionalusers?: {
              id: string;
          }[]

          Users

          Description

          Info on mentioned users

      • OptionalupdatedAt?: string

        Updated at Format: date-time

        Description

        The ISO 8601 timestamp that the note was updated at, if relevant

      • OptionalupdatedBy?: string

        Updated by

        Description

        The ID of the user who updated this note

    • OptionalparentListItemId?: string

      Format: uuid

      Description

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

    • serverId: string

      Server ID

      Description

      The ID of the server

    • OptionalupdatedAt?: string

      Updated at Format: date-time

      Description

      The ISO 8601 timestamp that the list item was updated at, if relevant

    • OptionalupdatedBy?: string

      Updated by

      Description

      The ID of the user who updated this list item

  • client: Client

    client.

  Returns ListItem

_data

channelID

completedAt

completedBy

content

createdAt

editedTimestamp

guildID

memberID

mentions

parentListItemID

updatedBy

webhookID

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>

note

• get note(): null | ListItemNoteTypes

• Returns null | ListItemNoteTypes

complete

• complete(): Promise<void>

• Set this item as "complete".

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this item.

  Returns Promise<void>

edit

• edit(options?): Promise<ListItem>

• Edit this item.

  Parameters

  • Optionaloptions: {
        content?: string;
        note?: null | {
            content: string;
        };
    }

    Edit options.

    • Optionalcontent?: string

    • Optionalnote?: null | {
          content: string;
      }

  Returns Promise<ListItem>

toJSON

• toJSON(): JSONListItem

• Returns JSONListItem

uncomplete

• uncomplete(): Promise<void>

• Set this item as "incomplete".

  Returns Promise<void>