Interface JSONDocComment

interface JSONDocComment {
    channelID: string;
    content: string;
    createdAt: Date;
    docID: number;
    guildID: null | string;
    id: number;
    memberID: string;
    mentions: null | {
        channels?: {
            id: string;
        }[];
        everyone?: boolean;
        here?: boolean;
        roles?: {
            id: number;
        }[];
        users?: {
            id: string;
        }[];
    };
    raw: {
        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;
    };
    updatedAt: null | Date;
}

Hierarchy (view full)

Properties

channelID content createdAt docID guildID id memberID mentions raw updatedAt

Properties

channelID

channelID: string

ID of the channel the comment is in.

content

content: string

The content of the comment.

createdAt

createdAt: Date

The date of the comment's creation.

docID

docID: number

The ID of the doc the comment is in.

guildID

guildID: null | string

ID of the guild, if provided.

id

id: number

memberID

memberID: string

ID of the member who created this comment.

mentions

mentions: null | {
    channels?: {
        id: string;
    }[];
    everyone?: boolean;
    here?: boolean;
    roles?: {
        id: number;
    }[];
    users?: {
        id: string;
    }[];
}

Mentions.

Type declaration

  • 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

raw

raw: {
    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

Type declaration

  • 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

updatedAt

updatedAt: null | Date

The date when the comment was last updated.

Settings

Member Visibility

On This Page

Properties