Class: ModerationEndpoint

Defined in: endpoints/moderation.ts:28

Constructors

Constructor

new ModerationEndpoint(client): ModerationEndpoint;

Defined in: endpoints/moderation.ts:29

Parameters

Parameter	Type
client	RESTClient

Returns

ModerationEndpoint

Methods

acknowledgeNotice()

acknowledgeNotice(noticeId): Promise<IApiResponse>;

Defined in: endpoints/moderation.ts:36

Parameters

Parameter	Type
noticeId	number

Returns

Promise<IApiResponse>

---

banMember()

banMember(
   serverId, 
   userId, 
   options?
): Promise<IApiResponse>;

Defined in: endpoints/moderation.ts:69

Ban someone: remove them if they are a member, and stop them joining until the ban is lifted. Anyone can be banned by user id, member or not.

Parameters

Parameter	Type
serverId	number
userId	number
options?	IBanOptions

Returns

Promise<IApiResponse>

---

disconnectFromVoice()

disconnectFromVoice(
   channelId, 
   userId, 
   message?
): Promise<IApiResponse>;

Defined in: endpoints/moderation.ts:61

remove a member from a voice call; they may rejoin

Parameters

Parameter	Type
channelId	number
userId	number
message?	string | null

Returns

Promise<IApiResponse>

---

getNotices()

getNotices(): Promise<IModerationNoticesResponse>;

Defined in: endpoints/moderation.ts:32

messages from moderators this user has not acknowledged yet

Returns

Promise<IModerationNoticesResponse>

---

listBans()

listBans(serverId): Promise<IServerBansResponse>;

Defined in: endpoints/moderation.ts:74

everyone banned from a server, most recent first

Parameters

Parameter	Type
serverId	number

Returns

Promise<IServerBansResponse>

---

removeTimeout()

removeTimeout(serverId, userId): Promise<ITimeoutMemberResponse>;

Defined in: endpoints/moderation.ts:56

Parameters

Parameter	Type
serverId	number
userId	number

Returns

Promise<ITimeoutMemberResponse>

---

timeoutMember()

timeoutMember(
   serverId, 
   userId, 
   durationSeconds, 
   message?
): Promise<ITimeoutMemberResponse>;

Defined in: endpoints/moderation.ts:44

stop a member sending, reacting or joining voice for durationSeconds. a non-empty message is delivered to them as a notice.

Parameters

Parameter	Type
serverId	number
userId	number
durationSeconds	number
message?	string | null

Returns

Promise<ITimeoutMemberResponse>

---

unbanMember()

unbanMember(
   serverId, 
   userId, 
   options?
): Promise<IApiResponse>;

Defined in: endpoints/moderation.ts:82

lift a ban; they can be invited again, but are not added back. With unhideMessages, what was hidden when they were banned shows again.

Parameters

Parameter	Type
serverId	number
userId	number
options?	{ unhideMessages?: boolean; }
options.unhideMessages?	boolean

Returns

Promise<IApiResponse>

---

updateBanNote()

updateBanNote(
   serverId, 
   userId, 
   note
): Promise<IServerBanResponse>;

Defined in: endpoints/moderation.ts:93

set the moderators' note on a ban; null or empty clears it

Parameters

Parameter	Type
serverId	number
userId	number
note	string | null

Returns

Promise<IServerBanResponse>