Interface GatewayEvent_DocCommentCreated

interface GatewayEvent_DocCommentCreated {
    docComment: {
        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;
    };
    serverId: string;
}

Properties

docComment serverId

Properties

docComment

docComment: {
    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;
}

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

serverId

serverId: string

The ID of the server

Settings

Member Visibility

On This Page

Properties