Class DocComment

constructor

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

• Parameters

  • data: APIDocComment

    raw data.

  • client: Client

    client.

  • Optional options: ConstructorDocCommentOptions

  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