Kiai Docs - Misc

Extends

BaseHandler

Constructors

Constructor

new Misc(handler): Misc

Parameters

Parameter	Type
`handler`	`RequestHandler`

Returns

Misc

Inherited from

BaseHandler.constructor

Properties

Property	Modifier	Type	Inherited from
`_handler`	`public`	`RequestHandler`	`BaseHandler._handler`

Methods

exportGuild()

exportGuild(guildId): Promise<GuildExportResponse>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<GuildExportResponse>

getFeaturePreviews()

getFeaturePreviews(guildId): Promise<FeaturePreview[]>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<FeaturePreview[]>

getGuildBlacklist()

getGuildBlacklist(guildId): Promise<BlacklistStatus>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<BlacklistStatus>

getGuildPremium()

getGuildPremium(guildId): Promise<PremiumStatus>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<PremiumStatus>

getMemberBlacklist()

getMemberBlacklist(guildId, userId): Promise<BlacklistStatus>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

Promise<BlacklistStatus>

getMemberPremium()

getMemberPremium(guildId, userId): Promise<PremiumStatus>

Parameters

Parameter	Type
`guildId`	`string`
`userId`	`string`

Returns

Promise<PremiumStatus>

getSelf()

getSelf(options?): Promise<MeResponse>

Get information about the current application.

Parameters

Parameter	Type
`options`	{ `guildId?`: `string`; `locale?`: `string`; }
`options.guildId?`	`string`
`options.locale?`	`string`

Returns

Promise<MeResponse>

postVirtualMessage()

postVirtualMessage(message): Promise<SuccessResponse>

Send a virtual message to the API.

Parameters

Parameter	Type
`message`	`VirtualMessage`

Returns

Promise<SuccessResponse>

triggerXpDrop()

triggerXpDrop(guildId, channelId, amount): Promise<XpDropResponse>

Parameters

Parameter	Type
`guildId`	`string`
`channelId`	`string`
`amount`	`number`

Returns

Promise<XpDropResponse>