Type alias DocCommentPayload

DocCommentPayload: {
    channelId: string;
    content: string;
    createdAt: string;
    createdBy: string;
    docId: number;
    id: number;
    mentions?: MentionsPayload;
    updatedAt?: string;
}

Type declaration

  • channelId: string

    The ID of the channel

  • content: string

    The content of the doc comment

  • createdAt: string

    The ISO 8601 timestamp that the doc comment was created at

  • createdBy: string

    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

    The ID of the doc

  • id: number

    The ID of the doc comment

  • Optional mentions?: MentionsPayload
  • Optional updatedAt?: string

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

Settings

Member Visibility

Theme

Generated using TypeDoc