Class GlobalRoleManager

A class representing a global role manager. At the moment, we don't cache roles in this structure.

Hierarchy

CacheableStructManager<number, Role>
- GlobalRoleManager

Index

Constructors

Properties

Methods

addRoleToMember create delete fetch fetchMany giveXP removeRoleFromMember update updatePermissions

Constructors

constructor

new GlobalRoleManager(client): GlobalRoleManager
Parameters
- client: Client
Returns GlobalRoleManager
Inherited from CacheableStructManager.constructor
- Defined in guilded.js/lib/managers/global/GlobalManager.ts:7

Properties

cache

cache: Collection<number, Role> = ...

`Readonly` client

client: Client

Methods

addRoleToMember

addRoleToMember(serverId, userId, roleId): Promise<void>
Assigns a role to a member.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the member.
- roleId: number
  
  The ID of the role.
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:154

create

create(serverId, options): Promise<Role>
Create a new role.
Parameters
- serverId: string
  
  The ID of the server.
- options: {}
  
  Role creation options.
Returns Promise<Role>
Promise that resolves with the newly created role.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:19

delete

delete(serverId, roleId): Promise<null | Role>
Delete a role by ID.
Parameters
- serverId: string
  
  ID of the server to delete the role.
- roleId: number
  
  ID of the role to delete.
Returns Promise<null | Role>
Promise that resolves with the cached deleted role, or null if the role isn't present in the cache.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:103

fetch

fetch(serverId, roleId, force?): Promise<Role>
Fetch a role by its ID
Parameters
- serverId: string
  
  The ID of the server.
- roleId: number
  
  ID of the role to fetch.
- Optional force: boolean
  
  Whether or not to force a fetch from the API.
Returns Promise<Role>
Promise that resolves with the fetched role.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:37

fetchMany

fetchMany(serverId): Promise<Collection<number, Role>>
Fetch all roles in a given server.
Parameters
- serverId: string
  
  The ID of the server.
Returns Promise<Collection<number, Role>>
Promise that resolves with a Collection of fetched roles.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:58

giveXP

giveXP(serverId, roleId, amount): Promise<void>
Awards XP to a role.
Parameters
- serverId: string
  
  The ID of the server.
- roleId: number
  
  The ID of the role.
- amount: number
  
  The amount of XP to award.
Returns Promise<void>
A Promise that resolves with the total XP awarded to the role.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:136

removeRoleFromMember

removeRoleFromMember(serverId, userId, roleId): Promise<void>
Removes a role from a member.
Parameters
- serverId: string
  
  The ID of the server.
- userId: string
  
  The ID of the member.
- roleId: number
  
  The ID of the role.
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:170

update

update(serverId, roleId, options): Promise<Role>
Update a role by ID.
Parameters
- serverId: string
  
  The ID of the server.
- roleId: number
  
  ID of the role to update.
- options: {}
  
  Role update options.
Returns Promise<Role>
Promise that resolves with the updated role.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:82

updatePermissions

updatePermissions(serverId, roleId, options): Promise<void>
Updates the permissions of a role.
Parameters
- serverId: string
  
  The ID of the server.
- roleId: number
  
  The ID of the role.
- options: {}
  
  Role permission update options.
Returns Promise<void>
A Promise that resolves with no value upon successful completion.
- Defined in guilded.js/lib/managers/global/RoleManager.ts:120

Generated using TypeDoc