Class GlobalDocManager

A manager class for Docs

Hierarchy

GlobalManager
- GlobalDocManager

Index

Constructors

Properties

Methods

create delete fetch fetchMany update

Constructors

constructor

new GlobalDocManager(client): GlobalDocManager
Parameters
- client: Client
Returns GlobalDocManager
Inherited from GlobalManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

`Readonly` client

client: Client

Methods

create

create(channelId, options): Promise<DocPayload>
Create a new Doc.
Parameters
- channelId: string
  
  The ID of the channel where the Doc should be created.
- options: {}
  
  The options for the Doc to be created.
Returns Promise<DocPayload>
A Promise that resolves with the Doc payload of the newly created Doc.
- Defined in guilded.js/lib/managers/global/DocManager.ts:16

delete

delete(channelId, docId): Promise<void>
Delete a Doc from a channel.
Parameters
- channelId: string
  
  The ID of the channel where the Doc is located.
- docId: number
  
  The ID of the Doc to delete.
Returns Promise<void>
A Promise that resolves with void when the Doc is successfully deleted.
- Defined in guilded.js/lib/managers/global/DocManager.ts:76

fetch

fetch(channelId, docId): Promise<DocPayload>
Fetch a Doc from a channel.
Parameters
- channelId: string
  
  The ID of the channel where the Doc is located.
- docId: number
  
  The ID of the Doc to fetch.
Returns Promise<DocPayload>
A Promise that resolves with the Doc payload of the fetched Doc.
- Defined in guilded.js/lib/managers/global/DocManager.ts:44

fetchMany

fetchMany(channelId): Promise<DocPayload[]>
Fetches multiple Docs from a channel.
Parameters
- channelId: string
  
  The ID of the channel where the Docs are located.
Returns Promise<DocPayload[]>
A Promise that resolves with an array of Doc payloads.
- Defined in guilded.js/lib/managers/global/DocManager.ts:30

update

update(channelId, docId, options): Promise<DocPayload>
Update a Doc.
Parameters
- channelId: string
  
  The ID of the channel where the Doc is located.
- docId: number
  
  The ID of the Doc to update.
- options: {}
  
  The options for the Doc update.
Returns Promise<DocPayload>
A Promise that resolves with the Doc payload of the updated Doc.
- Defined in guilded.js/lib/managers/global/DocManager.ts:60

Generated using TypeDoc