Class Doc

constructor

• new Doc(
      data: {
          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;
      },
      client: Client,
  ): Doc

  Parameters

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

    raw data

    • 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

  • client: Client

    client

  Returns Doc

channelID

comments

content

createdAt

editedTimestamp

guildID

memberID

mentions

name

updatedBy

member

• get member(): Member | Promise<Member>

  Retrieve the member who executed this action. Note: If this doc has been edited, the updatedBy id will be used to get you the member.

  Returns Member | Promise<Member>

delete

• delete(): Promise<void>

  Delete this doc.

  Returns Promise<void>

edit

• edit(options: EditDocOptions): Promise<Doc>

  Edit this doc.

  Parameters

  • options: EditDocOptions

    Edit options.

  Returns Promise<Doc>

toJSON

• toJSON(): JSONDoc

  Returns JSONDoc