Class Doc

Represents a doc on Guilded.

Example

new Doc(channel, rawDoc);

Hierarchy

Constructors

constructor

Properties

channel channelId client content createdAt createdBy editedAt? editedBy? id mentions? raw serverId title

Accessors

author authorId createdTimestamp editedTimestamp editor isCached server

Methods

delete edit fetch fetchAuthor fetchEditor fetchServer

Constructors

constructor

  • Parameters

    • channel: DocChannel

      The doc channel the doc belongs to.

    • raw: APIDoc

      The raw data of the doc.

    • Optional cache: boolean

      Whether to cache the doc.

    Returns Doc

Properties

Readonly channel

channel: DocChannel

Readonly channelId

channelId: string

The ID of the channel the doc belongs to.

Readonly client

client: Client

Readonly content

content: string

The content of the doc.

Readonly createdAt

createdAt: Date

The date the doc was created.

Readonly createdBy

createdBy: string

The ID of the user that created the doc.

Optional Readonly editedAt

editedAt?: Date

The date the doc was edited.

Optional Readonly editedBy

editedBy?: string

The ID of the user that edited the doc.

Readonly id

id: number

Optional Readonly mentions

mentions?: APIMentions

The mentions of the doc.

Readonly raw

raw: APIDoc

Readonly serverId

serverId: string

The ID of the server the doc belongs to.

Readonly title

title: string

The title of the doc.

Accessors

author

  • get author(): undefined | ServerMember

  • The server member that created the doc.

    Returns undefined | ServerMember

authorId

  • get authorId(): string

  • The ID of the user that created the doc.

    Returns string

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the doc was created.

    Returns number

editedTimestamp

  • get editedTimestamp(): undefined | number

  • The timestamp the doc was edited.

    Returns undefined | number

editor

  • get editor(): undefined | ServerMember

  • The server member that edited the doc.

    Returns undefined | ServerMember

isCached

  • get isCached(): boolean

  • Whether the doc is cached.

    Returns boolean

server

  • get server(): undefined | Server

  • The server the doc belongs to.

    Returns undefined | Server

Methods

delete

  • Delete the doc.

    Returns

    The deleted doc.

    Example

    doc.delete();

    Returns Promise<Doc>

edit

  • Edit the doc.

    Returns

    The edited doc.

    Example

    doc.edit('New title', 'New content');

    Parameters

    • title: string

      The title of the doc.

    • content: string

      The content of the doc.

    Returns Promise<Doc>

fetch

  • Fetch the doc.

    Returns

    The fetched doc.

    Example

    doc.fetch();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the doc with.

    Returns Promise<Doc>

fetchAuthor

  • Fetch the server member that created the doc.

    Returns

    The fetched server member.

    Example

    doc.fetchAuthor();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<ServerMember>

fetchEditor

  • Fetch the server member that edited the doc.

    Returns

    The fetched server member.

    Example

    doc.fetchEditor();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server member with.

    Returns Promise<undefined | ServerMember>

fetchServer

  • Fetch the server the doc belongs to.

    Returns

    The fetched server.

    Example

    doc.fetchServer();

    Parameters

    • Optional options: FetchOptions

      The options to fetch the server with.

    Returns Promise<Server>

Settings

Member Visibility

Theme