Class: BadgeEndpoint

Defined in: endpoints/badge.ts:20

Badges: pictures shown on people's profiles.

A server's badges are made and given out by members with manage_badges, and only show to people who share that server. Instance badges are made by instance admins, for things like events and easter eggs, and show everywhere. Both kinds share the badge id routes; which permission a change needs follows from the badge.

Constructors

Constructor

new BadgeEndpoint(client): BadgeEndpoint;

Defined in: endpoints/badge.ts:21

Parameters

Parameter	Type
client	RESTClient

Returns

BadgeEndpoint

Methods

assign()

assign(
   badgeId, 
   userId, 
   reason?
): Promise<IBadgeHolderResponse>;

Defined in: endpoints/badge.ts:55

Give someone a badge, or change the reason on one they have. A server badge needs them to be a member.

Parameters

Parameter	Type
badgeId	number
userId	number
reason?	string | null

Returns

Promise<IBadgeHolderResponse>

---

createInstanceBadge()

createInstanceBadge(badge): Promise<IBadgeResponse>;

Defined in: endpoints/badge.ts:37

Instance admins only.

Parameters

Parameter	Type
badge	IBadgeInput & object

Returns

Promise<IBadgeResponse>

---

createServerBadge()

createServerBadge(serverId, badge): Promise<IBadgeResponse>;

Defined in: endpoints/badge.ts:27

Parameters

Parameter	Type
serverId	number
badge	IBadgeInput & object

Returns

Promise<IBadgeResponse>

---

deleteBadge()

deleteBadge(badgeId): Promise<IApiResponse>;

Defined in: endpoints/badge.ts:46

Deleting a badge takes it off everyone who had it.

Parameters

Parameter	Type
badgeId	number

Returns

Promise<IApiResponse>

---

listHolders()

listHolders(badgeId): Promise<IBadgeHoldersResponse>;

Defined in: endpoints/badge.ts:50

Parameters

Parameter	Type
badgeId	number

Returns

Promise<IBadgeHoldersResponse>

---

listInstanceBadges()

listInstanceBadges(): Promise<IBadgesResponse>;

Defined in: endpoints/badge.ts:32

Instance admins only.

Returns

Promise<IBadgesResponse>

---

listServerBadges()

listServerBadges(serverId): Promise<IBadgesResponse>;

Defined in: endpoints/badge.ts:23

Parameters

Parameter	Type
serverId	number

Returns

Promise<IBadgesResponse>

---

unassign()

unassign(badgeId, userId): Promise<IApiResponse>;

Defined in: endpoints/badge.ts:59

Parameters

Parameter	Type
badgeId	number
userId	number

Returns

Promise<IApiResponse>

---

updateBadge()

updateBadge(badgeId, changes): Promise<IBadgeResponse>;

Defined in: endpoints/badge.ts:41

Parameters

Parameter	Type
badgeId	number
changes	IBadgeInput

Returns

Promise<IBadgeResponse>