Class GlobalWebhookManager

A manager for interacting with global webhooks. You can retrieve webhooks from the .cache property

Hierarchy

CacheableStructManager<string, Webhook>
- GlobalWebhookManager

Index

Constructors

Properties

Accessors

shouldCacheWebhook

Methods

create delete fetch fetchMany update

Constructors

constructor

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

Properties

cache

cache: Collection<string, Webhook> = ...

`Readonly` client

client: Client

Accessors

shouldCacheWebhook

get shouldCacheWebhook(): boolean
Returns boolean
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:13

Methods

create

create(serverId, options): Promise<Webhook>
Create a webhook
Parameters
- serverId: string
  
  The ID of the server to create the webhook for
- options: {}
  
  The options for creating the webhook
Returns Promise<Webhook>
A Promise that resolves to the created webhook
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:24

delete

delete(serverId, webhookId): Promise<void>
Delete a webhook
Parameters
- serverId: string
  
  The ID of the server the webhook is in
- webhookId: string
  
  The ID of the webhook to delete
Returns Promise<void>
A Promise that resolves with no value upon successful deletion
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:111

fetch

fetch(serverId, webhookId, force?): Promise<Webhook>
Get a webhook
Parameters
- serverId: string
  
  The ID of the server the webhook is in
- webhookId: string
  
  The ID of the webhook
- Optional force: boolean
  
  Whether to skip the cache check and request the API
Returns Promise<Webhook>
A Promise that resolves to the fetched webhook
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:66

fetchMany

fetchMany(serverId, channelId): Promise<Collection<string, Webhook>>
Get a server's webhooks
Parameters
- serverId: string
  
  The ID of the server to get webhooks for
- channelId: string
  
  The ID of the channel to get webhooks for
Returns Promise<Collection<string, Webhook>>
A Promise that resolves to a Collection of Webhooks
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:43

update

update(serverId, webhookId, options): Promise<Webhook>
Update a webhook
Parameters
- serverId: string
  
  The ID of the server the webhook is in
- webhookId: string
  
  The ID of the webhook to update
- options: {}
  
  The options for updating the webhook
Returns Promise<Webhook>
A Promise that resolves to the updated Webhook
- Defined in guilded.js/lib/managers/global/WebhookManager.ts:89

Generated using TypeDoc