Class: BotEndpoint

Defined in: endpoints/bot.ts:17

Manage server bot identities using a human session with Create bots permission.

Constructors

Constructor

new BotEndpoint(client): BotEndpoint;

Defined in: endpoints/bot.ts:18

Parameters

Parameter	Type
client	RESTClient

Returns

BotEndpoint

Methods

checkUsername()

checkUsername(
   serverId, 
   username, 
   botId?
): Promise<IServerBotUsernameResponse>;

Defined in: endpoints/bot.ts:37

Whether username is free to be a bot's handle. Pass botId when renaming that bot, so its own handle counts as free.

Parameters

Parameter	Type
serverId	number
username	string
botId?	number

Returns

Promise<IServerBotUsernameResponse>

---

create()

create(serverId, input): Promise<IServerBotTokenResponse>;

Defined in: endpoints/bot.ts:24

Parameters

Parameter	Type
serverId	number
input	ICreateServerBot

Returns

Promise<IServerBotTokenResponse>

---

list()

list(serverId): Promise<IServerBotsResponse>;

Defined in: endpoints/bot.ts:20

Parameters

Parameter	Type
serverId	number

Returns

Promise<IServerBotsResponse>

---

preview()

preview(serverId, input): Promise<IServerBotPreviewResponse>;

Defined in: endpoints/bot.ts:29

Authoritative current grants in channels visible to the approving human.

Parameters

Parameter	Type
serverId	number
input	IServerBotPreviewInput

Returns

Promise<IServerBotPreviewResponse>

---

remove()

remove(serverId, botId): Promise<IApiResponse>;

Defined in: endpoints/bot.ts:69

Parameters

Parameter	Type
serverId	number
botId	number

Returns

Promise<IApiResponse>

---

removeAvatar()

removeAvatar(serverId, botId): Promise<IServerBotResponse>;

Defined in: endpoints/bot.ts:56

Parameters

Parameter	Type
serverId	number
botId	number

Returns

Promise<IServerBotResponse>

---

rotateToken()

rotateToken(serverId, botId): Promise<IServerBotTokenResponse>;

Defined in: endpoints/bot.ts:65

Invalidates the previous token immediately; the bot's identity is preserved.

Parameters

Parameter	Type
serverId	number
botId	number

Returns

Promise<IServerBotTokenResponse>

---

update()

update(
   serverId, 
   botId, 
   input
): Promise<IServerBotResponse>;

Defined in: endpoints/bot.ts:60

Parameters

Parameter	Type
serverId	number
botId	number
input	IUpdateServerBot

Returns

Promise<IServerBotResponse>

---

updateProfile()

updateProfile(
   serverId, 
   botId, 
   profile
): Promise<IServerBotResponse>;

Defined in: endpoints/bot.ts:44

Change what the bot's profile shows. Fields left out are unchanged; null clears one.

Parameters

Parameter	Type
serverId	number
botId	number
profile	IServerBotProfileUpdate

Returns

Promise<IServerBotResponse>

---

uploadAvatar()

uploadAvatar(
   serverId, 
   botId, 
   file, 
   filename
): Promise<IServerBotResponse>;

Defined in: endpoints/bot.ts:48

Parameters

Parameter	Type
serverId	number
botId	number
file	Blob
filename	string

Returns

Promise<IServerBotResponse>