Create a new Guild Scheduled Event Method Handler
Usually SnowTransfer creates a method handler for you, this is here for completion
You can access the methods listed via client.guildscheduledevent.method, where client is an initialized SnowTransfer instance
request handler that calls the rest api
Create a scheduled event for a guild
The Id of the guild
Create data
| Permissions needed | Condition |
|---|---|
| MANAGE_EVENTS | always |
| MANAGE_CHANNELS | If entity_type is STAGE_INSTANCE |
| MUTE_MEMBERS | If entity_type is STAGE_INSTANCE |
| MOVE_MEMBERS | If entity_type is STAGE_INSTANCE |
| VIEW_CHANNEL | If entity_type is VOICE |
| CONNECT | If entity_type is VOICE |
Delete a specific scheduled event for a guild
The Id of the guild
The Id of the event
Resolves the promise on successful execution
| Permissions needed | Condition |
|---|---|
| MANAGE_EVENTS | always |
| MANAGE_CHANNELS | If entity_type is STAGE_INSTANCE |
| MUTE_MEMBERS | If entity_type is STAGE_INSTANCE |
| MOVE_MEMBERS | If entity_type is STAGE_INSTANCE |
| VIEW_CHANNEL | If entity_type is VOICE |
| CONNECT | If entity_type is VOICE |
Edit the details of a scheduled event for a guild
The Id of the guild
The Id of the event
Edit data
| Permissions needed | Condition |
|---|---|
| MANAGE_EVENTS | always |
| MANAGE_CHANNELS | If entity_type is STAGE_INSTANCE |
| MUTE_MEMBERS | If entity_type is STAGE_INSTANCE |
| MOVE_MEMBERS | If entity_type is STAGE_INSTANCE |
| VIEW_CHANNEL | If entity_type is VOICE |
| CONNECT | If entity_type is VOICE |
Get a specific scheduled event for a guild
The Id of the guild
The Id of the event
Options for if how many users will be or are attending
| Permissions needed | Condition |
|---|---|
| VIEW_CHANNEL | if entity_type is STAGE_INSTANCE or VOICE |
Get a list of users attending a specific event
The Id of the guild
The Id of the event
Options for how to get users
An array of event users
| Permissions needed | Condition |
|---|---|
| VIEW_CHANNEL | if entity_type is STAGE_INSTANCE or VOICE |
Get all scheduled events for a guild
The Id of the guild
Options for if how many users will be or are attending
An array of guild scheduled events
| Permissions needed | Condition |
|---|---|
| VIEW_CHANNEL | if entity_type is STAGE_INSTANCE or VOICE |
Generated using TypeDoc
Methods for interacting with Guild Scheduled Events