Class: RoleEndpoint

Defined in: endpoints/role.ts:19

Constructors

Constructor

new RoleEndpoint(client): RoleEndpoint;

Defined in: endpoints/role.ts:20

Parameters

Parameter	Type
client	RESTClient

Returns

RoleEndpoint

Methods

assignRoleToMember()

assignRoleToMember(
   serverId, 
   userId, 
   roleId
): Promise<IAssignRoleResponse>;

Defined in: endpoints/role.ts:46

Parameters

Parameter	Type
serverId	number
userId	number
roleId	number

Returns

Promise<IAssignRoleResponse>

---

createServerRole()

createServerRole(serverId, data?): Promise<ICreateServerRoleResponse>;

Defined in: endpoints/role.ts:30

Parameters

Parameter	Type
serverId	number
data?	Record<string, any>

Returns

Promise<ICreateServerRoleResponse>

---

deleteServerRole()

deleteServerRole(serverId, roleId): Promise<IDeleteServerRoleResponse>;

Defined in: endpoints/role.ts:42

Parameters

Parameter	Type
serverId	number
roleId	number

Returns

Promise<IDeleteServerRoleResponse>

---

getCategoryRoleOverrides()

getCategoryRoleOverrides(serverId, categoryId): Promise<IChannelRoleOverridesResponse>;

Defined in: endpoints/role.ts:86

every role's allow and deny for a category, which its synced channels follow

Parameters

Parameter	Type
serverId	number
categoryId	number

Returns

Promise<IChannelRoleOverridesResponse>

---

getChannelRoleOverrides()

getChannelRoleOverrides(serverId, channelId): Promise<IChannelRoleOverridesResponse>;

Defined in: endpoints/role.ts:105

every role's allow and deny for one channel

Parameters

Parameter	Type
serverId	number
channelId	number

Returns

Promise<IChannelRoleOverridesResponse>

---

getMemberRoles()

getMemberRoles(serverId, userId): Promise<IGetMemberRolesResponse>;

Defined in: endpoints/role.ts:54

Parameters

Parameter	Type
serverId	number
userId	number

Returns

Promise<IGetMemberRolesResponse>

---

getRoleMembers()

getRoleMembers(serverId, roleId): Promise<IRoleMembersResponse>;

Defined in: endpoints/role.ts:66

Parameters

Parameter	Type
serverId	number
roleId	number

Returns

Promise<IRoleMembersResponse>

---

getServerRole()

getServerRole(serverId, roleId): Promise<IGetServerRoleResponse>;

Defined in: endpoints/role.ts:26

Parameters

Parameter	Type
serverId	number
roleId	number

Returns

Promise<IGetServerRoleResponse>

---

listServerRoles()

listServerRoles(serverId): Promise<IListServerRolesResponse>;

Defined in: endpoints/role.ts:22

Parameters

Parameter	Type
serverId	number

Returns

Promise<IListServerRolesResponse>

---

removeRoleFromMember()

removeRoleFromMember(
   serverId, 
   userId, 
   roleId
): Promise<IRemoveRoleResponse>;

Defined in: endpoints/role.ts:50

Parameters

Parameter	Type
serverId	number
userId	number
roleId	number

Returns

Promise<IRemoveRoleResponse>

---

setCategoryRoleOverride()

setCategoryRoleOverride(
   serverId, 
   categoryId, 
   roleId, 
   allow?, 
   deny?
): Promise<IApiResponse>;

Defined in: endpoints/role.ts:91

set or clear a category override for a role; its synced channels take the change too

Parameters

Parameter	Type
serverId	number
categoryId	number
roleId	number
allow?	Record<string, boolean>
deny?	Record<string, boolean>

Returns

Promise<IApiResponse>

---

setChannelRoleOverride()

setChannelRoleOverride(
   serverId, 
   channelId, 
   roleId, 
   allow?, 
   deny?
): Promise<IApiResponse>;

Defined in: endpoints/role.ts:114

set or clear a channel override for a role. Clearing both on a channel that is not private removes the override; on a private channel the role keeps its place on the access list.

Parameters

Parameter	Type
serverId	number
channelId	number
roleId	number
allow?	Record<string, boolean>
deny?	Record<string, boolean>

Returns

Promise<IApiResponse>

---

setMemberRoles()

setMemberRoles(
   serverId, 
   userId, 
   roleIds
): Promise<ISetMemberRolesResponse>;

Defined in: endpoints/role.ts:62

replace every role a member holds with roleIds; roles the caller may not manage are left as they are

Parameters

Parameter	Type
serverId	number
userId	number
roleIds	number[]

Returns

Promise<ISetMemberRolesResponse>

---

setRoleMembers()

setRoleMembers(
   serverId, 
   roleId, 
   userIds
): Promise<ISetRoleMembersResponse>;

Defined in: endpoints/role.ts:71

replace everyone who holds a role with userIds

Parameters

Parameter	Type
serverId	number
roleId	number
userIds	number[]

Returns

Promise<ISetRoleMembersResponse>

---

updateRolePositions()

updateRolePositions(serverId, updates): Promise<IUpdateRolePositionsResponse>;

Defined in: endpoints/role.ts:75

Parameters

Parameter	Type
serverId	number
updates	object[]

Returns

Promise<IUpdateRolePositionsResponse>

---

updateServerRole()

updateServerRole(
   serverId, 
   roleId, 
   data
): Promise<IUpdateServerRoleResponse>;

Defined in: endpoints/role.ts:34

Parameters

Parameter	Type
serverId	number
roleId	number
data	Record<string, any>

Returns

Promise<IUpdateServerRoleResponse>