Class DocComment

constructor

• new DocComment(data, client, options?): DocComment

• Parameters

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

    raw data.

    • channelId: string

      Channel ID Format: uuid

      Description

      The ID of the channel

    • content: string

      Content Format: long-form markdown

      Description

      The content of the doc comment

    • createdAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the doc comment was created at

    • createdBy: string

      Created by

      Description

      The ID of the user who created this doc comment (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)

    • docId: number

      Doc ID

      Description

      The ID of the doc

    • id: number

      Doc comment ID

      Description

      The ID of the doc comment

    • 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 doc comment was updated at, if relevant

  • client: Client

    client.
  • Optionaloptions: ConstructorDocCommentOptions

    Additional properties that can be added.

  Returns DocComment

channelID

content

createdAt

docID

guildID

memberID

mentions

raw

updatedAt

member

• get member(): undefined | Member | Promise<Member>

• Retrieve the member who sent this comment, if cached. If there is no cached member, this will make a rest request which returns a Promise. If the request fails, it'll return undefined or throw an error that you can catch.

  Returns undefined | Member | Promise<Member>

createDocComment

• createDocComment(options): Promise<DocComment>

• Create a comment in the same doc as this one.

  Parameters

  • options: CreateDocCommentOptions

    Create options.

  Returns Promise<DocComment>

createReaction

• createReaction(reaction): Promise<void>

• Add a reaction to this comment.

  Parameters

  • reaction: number

    ID of the reaction to add.

  Returns Promise<void>

delete

• delete(): Promise<void>

• Delete this comment

  Returns Promise<void>

deleteReaction

• deleteReaction(reaction): Promise<void>

• Remove a reaction from this comment.

  Parameters

  • reaction: number

    ID of the reaction to remove.

  Returns Promise<void>

edit

• edit(options): Promise<DocComment>

• Edit this comment

  Parameters

  • options: EditDocCommentOptions

  Returns Promise<DocComment>

toJSON

• toJSON(): JSONDocComment

• Returns JSONDocComment