Interface GatewayEvent_DocCreated

interface GatewayEvent_DocCreated {
    doc: {
        channelId: string;
        content: string;
        createdAt: string;
        createdBy: string;
        groupId: string;
        id: number;
        mentions?: {
            channels?: { id: string }[];
            everyone?: boolean;
            here?: boolean;
            roles?: { id: number }[];
            users?: { id: string }[];
        };
        serverId: string;
        title: string;
        updatedAt?: string;
        updatedBy?: string;
    };
    serverId: string;
}

Properties

doc serverId

Properties

doc

doc: {
    channelId: string;
    content: string;
    createdAt: string;
    createdBy: string;
    groupId: string;
    id: number;
    mentions?: {
        channels?: { id: string }[];
        everyone?: boolean;
        here?: boolean;
        roles?: { id: number }[];
        users?: { id: string }[];
    };
    serverId: string;
    title: string;
    updatedAt?: string;
    updatedBy?: 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

  • createdAt: string

    Created at Format: date-time

    Description

    The ISO 8601 timestamp that the doc was created at

  • createdBy: string

    Created by

    Description

    The ID of the user who created this doc

  • groupId: string

    Group ID

    Description

    The ID of the group

  • id: number

    Doc ID

    Description

    The ID of the doc

  • 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

  • serverId: string

    Server ID

    Description

    The ID of the server

  • title: string

    Title

    Description

    The title of the doc

  • OptionalupdatedAt?: string

    Updated at Format: date-time

    Description

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

  • OptionalupdatedBy?: string

    Updated by

    Description

    The ID of the user who updated this doc

serverId

serverId: string

The ID of the server

Settings

Member Visibility

On This Page

Properties