Class Doc

Represents a doc on Guilded.

Example

new Doc(channel, rawDoc);

Hierarchy

Base<number>
- Doc

Index

Constructors

constructor

new Doc(channel: DocChannel, raw: APIDoc, cache?: boolean): Doc
Parameters
- channel: DocChannel
  
  The doc channel the doc belongs to.
- raw: APIDoc
  
  The raw data of the doc.
- cache: boolean = ...
  
  Whether to cache the doc.
Returns Doc
Overrides Base.constructor
- Defined in guilded.ts/src/structures/Doc.ts:35

Properties

`Readonly` channel

channel: DocChannel

The doc channel the doc belongs to.

`Readonly` channelId

channelId: string

The ID of the channel the doc belongs to.

`Readonly` client

client: Client

The client the data model belongs to.

`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

The ID of the structure.

`Optional` `Readonly` mentions

mentions?: APIMentions

The mentions of the doc.

`Readonly` raw

raw: APIDoc

The raw data of the doc.

`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
- Defined in guilded.ts/src/structures/Doc.ts:69

authorId

get authorId(): string
The ID of the user that created the doc.

Returns string
- Defined in guilded.ts/src/structures/Doc.ts:74

createdTimestamp

get createdTimestamp(): number
The timestamp the doc was created.

Returns number
- Defined in guilded.ts/src/structures/Doc.ts:64

editedTimestamp

get editedTimestamp(): undefined | number
The timestamp the doc was edited.

Returns undefined | number
- Defined in guilded.ts/src/structures/Doc.ts:79

editor

get editor(): undefined | ServerMember
The server member that edited the doc.

Returns undefined | ServerMember
- Defined in guilded.ts/src/structures/Doc.ts:84

isCached

get isCached(): boolean
Whether the doc is cached.

Returns boolean
- Defined in guilded.ts/src/structures/Doc.ts:54

server

get server(): undefined | Server
The server the doc belongs to.

Returns undefined | Server
- Defined in guilded.ts/src/structures/Doc.ts:59

Methods

delete

delete(): Promise<Doc>
Delete the doc.

Returns
The deleted doc.

Example
```
doc.delete();
```
Returns Promise<Doc>
- Defined in guilded.ts/src/structures/Doc.ts:146

edit

edit(title: string, content: string): Promise<Doc>
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>
- Defined in guilded.ts/src/structures/Doc.ts:137

fetch

fetch(options?: FetchOptions): Promise<Doc>
Fetch the doc.

Returns
The fetched doc.

Example
```
doc.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the doc with.
Returns Promise<Doc>
- Defined in guilded.ts/src/structures/Doc.ts:94

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
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>
- Defined in guilded.ts/src/structures/Doc.ts:114

fetchEditor

fetchEditor(options?: FetchOptions): Promise<undefined | ServerMember>
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>
- Defined in guilded.ts/src/structures/Doc.ts:125

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
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>
- Defined in guilded.ts/src/structures/Doc.ts:104

Class Doc

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: DocChannel

raw: APIDoc

cache: boolean = ...

Returns Doc

Properties

Readonly channel

Readonly channelId

Readonly client

Readonly content

Readonly createdAt

Readonly createdBy

Optional Readonly editedAt

Optional Readonly editedBy

Readonly id

Optional Readonly mentions

Readonly raw

Readonly serverId

Readonly title

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

createdTimestamp

Returns number

editedTimestamp

Returns undefined | number

editor

Returns undefined | ServerMember

isCached

Returns boolean

server

Returns undefined | Server

Methods

delete

Returns

Example

Returns Promise<Doc>

edit

Returns

Example

Parameters

title: string

content: string

Returns Promise<Doc>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Doc>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchEditor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<undefined | ServerMember>

fetchServer

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Server>

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Readonly` content

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` editedAt

`Optional` `Readonly` editedBy

`Readonly` id

`Optional` `Readonly` mentions

`Readonly` raw

`Readonly` serverId

`Readonly` title

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions