Overview
Methods
Can be accessed using client.badges on an
ApiClient
instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const cheermotes = await api.badges.getGlobalBadges();
Methods
getChannelBadges(channel, includeGlobal, language)
asyncRetrieves all applicable chat badges for a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none |
The channel to retrieve the chat badges for. |
|
| includeGlobal | boolean | true |
Whether to include global badges in the result list. |
|
| language | string | none |
The language of the retrieved badge descriptions. |
Return type:
ChatBadgeList
getGlobalBadges(language)
asyncRetrieves all globally applicable chat badges.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| language | string | none |
The language of the retrieved badge descriptions. |
Return type:
ChatBadgeList