RoleManager
Defined in: packages/managers/src/role.ts:36
Manages Discord guild roles.
Extends
Section titled “Extends”ResourceManager<string,Role>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RoleManager(
guildId,rest):RoleManager
Defined in: packages/managers/src/role.ts:40
Parameters
Section titled “Parameters”guildId
Section titled “guildId”string
Returns
Section titled “Returns”RoleManager
Overrides
Section titled “Overrides”Properties
Section titled “Properties”
readonlycache:Collection<string,Role>
Defined in: packages/managers/src/base.ts:27
Authoritative resource state. Entries never expire: see Manager.set.
Inherited from
Section titled “Inherited from”guildId
Section titled “guildId”
readonlyguildId:string
Defined in: packages/managers/src/role.ts:38
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: packages/managers/src/base.ts:105
Gets cache size.
Returns
Section titled “Returns”number
Number of cached values.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<[string,Role]>
Defined in: packages/managers/src/base.ts:121
Iterates cached entries.
Returns
Section titled “Returns”IterableIterator<[string, Role]>
Cache iterator.
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/managers/src/base.ts:101
Clears the cache.
Returns
Section titled “Returns”void
Nothing.
Inherited from
Section titled “Inherited from”create()
Section titled “create()”create(
options):Promise<Role>
Defined in: packages/managers/src/role.ts:61
Creates a new role in the guild.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Role>
delete()
Section titled “delete()”delete(
id):boolean
Defined in: packages/managers/src/base.ts:96
Deletes a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when deleted.
Inherited from
Section titled “Inherited from”edit()
Section titled “edit()”edit(
roleId,options):Promise<Role>
Defined in: packages/managers/src/role.ts:72
Edits an existing role.
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
options
Section titled “options”Returns
Section titled “Returns”Promise<Role>
fetch()
Section titled “fetch()”fetch(
id):Promise<Role>
Defined in: packages/managers/src/base.ts:150
Fetches from Discord; a cached instance is updated in place, so references to it stay current.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Role>
Inherited from
Section titled “Inherited from”fetchAll()
Section titled “fetchAll()”fetchAll():
Promise<Role[]>
Defined in: packages/managers/src/role.ts:53
Fetches all roles in the guild.
Returns
Section titled “Returns”Promise<Role[]>
fetchMany()
Section titled “fetchMany()”fetchMany(
ids):Promise<Role[]>
Defined in: packages/managers/src/base.ts:158
Parameters
Section titled “Parameters”Iterable<string>
Returns
Section titled “Returns”Promise<Role[]>
Inherited from
Section titled “Inherited from”find()
Section titled “find()”find(
predicate):Role|undefined
Defined in: packages/managers/src/base.ts:117
Finds a cached value.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, key) => boolean
Predicate.
Returns
Section titled “Returns”Role | undefined
Matching value.
Inherited from
Section titled “Inherited from”first()
Section titled “first()”first():
Role|undefined
Defined in: packages/managers/src/base.ts:109
Gets the first cached value.
Returns
Section titled “Returns”Role | undefined
First value.
Inherited from
Section titled “Inherited from”get(
id):Role|undefined
Defined in: packages/managers/src/base.ts:36
Gets a cached value.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”Role | undefined
Cached value.
Inherited from
Section titled “Inherited from”has(
id):boolean
Defined in: packages/managers/src/base.ts:40
Checks whether a value is cached.
Parameters
Section titled “Parameters”string
Cache key.
Returns
Section titled “Returns”boolean
True when cached.
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove(
roleId,reason?):Promise<void>
Defined in: packages/managers/src/role.ts:88
Deletes a role.
Parameters
Section titled “Parameters”roleId
Section titled “roleId”string
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<void>
resolve()
Section titled “resolve()”resolve(
id):Promise<Role>
Defined in: packages/managers/src/base.ts:145
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Role>
Inherited from
Section titled “Inherited from”set(
id,value):this
Defined in: packages/managers/src/base.ts:88
Stores a resource with setWithoutTTL(), so it leaves only on an explicit delete (e.g. a Gateway *_DELETE), never through TTL.
Parameters
Section titled “Parameters”string
Cache key.
Value.
Returns
Section titled “Returns”this
This manager.
Inherited from
Section titled “Inherited from”setPositions()
Section titled “setPositions()”setPositions(
positions,reason?):Promise<Role[]>
Defined in: packages/managers/src/role.ts:100
Moves roles in the hierarchy. Discord shifts the other roles around them.
Parameters
Section titled “Parameters”positions
Section titled “positions”readonly object[]
Each role’s ID and its new position.
reason?
Section titled “reason?”string
Audit-log reason.
Returns
Section titled “Returns”Promise<Role[]>
Every role in the guild, in their new order.
update()
Section titled “update()”update(
resource):Role
Defined in: packages/managers/src/base.ts:180
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”upsert()
Section titled “upsert()”upsert(
resource):Role
Defined in: packages/managers/src/base.ts:163
Stores a resource, merging into the cached instance when there is one so existing references stay current.
Parameters
Section titled “Parameters”resource
Section titled “resource”Returns
Section titled “Returns”The canonical instance.
Inherited from
Section titled “Inherited from”values()
Section titled “values()”values():
Role[]
Defined in: packages/managers/src/base.ts:113
Returns cached values.
Returns
Section titled “Returns”Role[]
Array of values.