GuildScheduledEventUsersManager
GuildScheduledEventUsersManager ⇐ Base
Represents a manager for handling guild scheduled event users.
Kind: global class
Extends: Base
- GuildScheduledEventUsersManager ⇐
Base
- new GuildScheduledEventUsersManager(event, guildId, client)
- instance
- .resolve(scheduledEventUser, event) ⇒
GuildScheduledEventUser
|null
- .fetch([event], [options]) ⇒
Promise.<RaidenCol>
- .resolve(scheduledEventUser, event) ⇒
- static
- .transformQuery(query) ⇒
Object
- .transformQuery(query) ⇒
new GuildScheduledEventUsersManager(event, guildId, client)
Constructs a new instance of the class.
Param | Type | Description |
---|---|---|
event | Event | The event object. |
guildId | string | The ID of the guild. |
client | Client | The client object. |
guildScheduledEventUsersManager.resolve(scheduledEventUser, event) ⇒ GuildScheduledEventUser
| null
Resolves a scheduled event user and returns a GuildScheduledEventUser object.
Kind: instance method of GuildScheduledEventUsersManager
Returns: GuildScheduledEventUser
| null
- - The resolved GuildScheduledEventUser object or null if scheduledEventUser is falsy.
Param | Type | Description |
---|---|---|
scheduledEventUser | string | null | The scheduled event user to resolve. |
event | object | The event object. |
guildScheduledEventUsersManager.fetch([event], [options]) ⇒ Promise.<RaidenCol>
Fetches the users associated with a scheduled event in a guild.
Kind: instance method of GuildScheduledEventUsersManager
Returns: Promise.<RaidenCol>
- - A promise that resolves to a RaidenCol object containing the fetched users.
Param | Type | Default | Description |
---|---|---|---|
[event] | Event | string | this.event | The event object or event ID. |
[options] | object | Additional options for the fetch request. |
GuildScheduledEventUsersManager.transformQuery(query) ⇒ Object
Transforms a query object into a formatted query object with default values and proper type checking.
Kind: static method of GuildScheduledEventUsersManager
Returns: Object
- - The transformed query object.
Param | Type | Description |
---|---|---|
query | Object | The query object to transform. |