Interface APIDocComment

Hierarchy

  • APIDocComment

Properties

channelId content createdAt createdBy docId id mentions? updatedAt?

Properties

channelId

channelId: string

The ID of the channel

content

content: string

The content of the doc comment (min length 1; max length 10000)

createdAt

createdAt: string

The ISO 8601 timestamp that the doc comment was created at

createdBy

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

docId: number

The ID of the doc (min 1)

id

id: number

The ID of the doc comment

Optional mentions

mentions?: APIMentions

Optional updatedAt

updatedAt?: string

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

Settings

Member Visibility

Theme

On This Page