Class REST/Miscellaneous

Methods that don't fit anywhere else. Located at Client#rest .misc.

Index

Constructors

Methods

createTestEntitlement deleteEntitlement getApplication getClientApplication getEntitlements getSKUs getSticker getStickerPacks getVoiceRegions

Constructors

constructor

new Miscellaneous(manager): REST/Miscellaneous
Parameters
- manager: RESTManager
Returns REST/Miscellaneous
- Defined in lib/routes/Miscellaneous.ts:23

Methods

createTestEntitlement

createTestEntitlement(applicationID, options): Promise<TestEntitlement>
Create a test entitlement.
Parameters
- applicationID: string
  The ID of the application to create the entitlement for.
- options: CreateTestEntitlementOptions
  The options for creating the test entitlement.
Returns Promise<TestEntitlement>
- Defined in lib/routes/Miscellaneous.ts:32

deleteEntitlement

deleteEntitlement(applicationID, entitlementID): Promise<void>
Delete an entitlement.
Parameters
- applicationID: string
  The ID of the application to delete the entitlement from.
- entitlementID: string
  The ID of the entitlement to delete.
Returns Promise<void>
- Defined in lib/routes/Miscellaneous.ts:49

getApplication

getApplication(): Promise<Application>
Get the currently authenticated bot's application info.

Returns Promise<Application>
Caching
This method does not cache its result.
- Defined in lib/routes/Miscellaneous.ts:60

getClientApplication

getClientApplication(): Promise<ClientApplication>
Get the currently authenticated bot's application info as a bare ClientApplication.

Returns Promise<ClientApplication>
Caching
This method does not cache its result.
- Defined in lib/routes/Miscellaneous.ts:71

getEntitlements

getEntitlements(applicationID, options?): Promise<(Entitlement | TestEntitlement)[]>
Get the entitlements for an application.
Parameters
- applicationID: string
  The ID of the application to get the entitlements of.
- options: SearchEntitlementsOptions = {}
  The options for getting the entitlements.
Returns Promise<(Entitlement | TestEntitlement)[]>
- Defined in lib/routes/Miscellaneous.ts:83

getSKUs

getSKUs(applicationID): Promise<SKU[]>
Get the SKUs for an application.
Parameters
- applicationID: string
  The ID of the application to get the SKUs of.
Returns Promise<SKU[]>
- Defined in lib/routes/Miscellaneous.ts:103

getSticker

getSticker(stickerID): Promise<Sticker>
Get a sticker.
Parameters
- stickerID: string
  The ID of the sticker to get.
Returns Promise<Sticker>
Caching
This method may cache its result. The result will not be cached if the guild is not cached, or if the sticker is not a guild sticker.

Caches
Guild#stickers
- Defined in lib/routes/Miscellaneous.ts:129

getStickerPacks

getStickerPacks(): Promise<StickerPack[]>
Get the default sticker packs.

Returns Promise<StickerPack[]>
Caching
This method does not cache its result.
- Defined in lib/routes/Miscellaneous.ts:140

getVoiceRegions

getVoiceRegions(): Promise<VoiceRegion[]>
Get the list of usable voice regions.

Returns Promise<VoiceRegion[]>
Caching
This method does not cache its result.
- Defined in lib/routes/Miscellaneous.ts:159