GuildScheduledEventMethods

Methods for interacting with Guild Scheduled Events

Hierarchy

GuildScheduledEventMethods

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GuildScheduledEventMethods(requestHandler: <internal>.RequestHandler): <internal>.GuildScheduledEventMethods

- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/methods/GuildScheduledEvent.d.ts:15
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

Parameters
- requestHandler: <internal>.RequestHandler
  
  request handler that calls the rest api
Returns <internal>.GuildScheduledEventMethods

Properties

requestHandler

requestHandler: <internal>.RequestHandler

Static default

default: typeof <internal>.GuildScheduledEventMethods

Methods

createGuildScheduledEvent

createGuildScheduledEvent(guildId: string, data: CreateGuildScheduledEventData): Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

Create a scheduled event for a guild

example: const client = new SnowTransfer("TOKEN") const eventData = { name: "My event!", entity_type: 1, start_time: "2020-01-01T00:00:00Z", privacy_level: 1 } const event = await client.guildScheduledEvent.createGuildScheduledEvent(guildId, eventData)

Parameters

guildId: string

The Id of the guild
data: CreateGuildScheduledEventData

Data for the new scheduled event

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

A scheduled event

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

deleteGuildScheduledEvent

deleteGuildScheduledEvent(guildId: string, eventId: string): Promise<void>

Delete a specific scheduled event for a guild

example: const client = new SnowTransfer("TOKEN") client.guildScheduledEvent.deleteGuildScheduledEvent(guildId, eventId)

Parameters

guildId: string

The Id of the guild
eventId: string

The Id of the event

Returns Promise<void>

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

editGuildScheduledEvent

editGuildScheduledEvent(guildId: string, eventId: string, data: EditGuildScheduledEventData): Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

Edit the details of a scheduled event for a guild

example: // Updates a scheduled event to be an external event that will take place in Brazil and end in 2025 const client = new SnowTransfer("TOKEN") const event = await client.guildScheduledEvent.editGuildScheduledEvent(guildId, eventId, { entity_type: 3, channel_id: null, entity_metadata: { location: "Brazil" }, scheduled_end_time: "2025-01-01T00:00:00.000Z" })

Parameters

guildId: string

The Id of the guild
eventId: string

The Id of the event
data: EditGuildScheduledEventData

Edited scheduled event data

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

A scheduled event

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

getGuildScheduledEvent

getGuildScheduledEvent(guildId: string, eventId: string, withCount?: boolean): Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/methods/GuildScheduledEvent.d.ts:68
Get a specific scheduled event for a guild

example
const client = new SnowTransfer("TOKEN") const event = await client.guildScheduledEvent.getGuildScheduledEvent(guildId, eventId)

Parameters
- guildId: string
  
  The Id of the guild
- eventId: string
  
  The Id of the event
- Optional withCount: boolean
  
  Include number of users subscribed to this event
Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>
A scheduled event

Permissions needed Condition

VIEW_CHANNEL if entity_type is STAGE_INSTANCE or VOICE

Permissions needed	Condition
VIEW_CHANNEL	if entity_type is STAGE_INSTANCE or VOICE

getGuildScheduledEventUsers

getGuildScheduledEventUsers(guildId: string, eventId: string, query?: <internal>.GetGuildScheduledEventUsers): Promise<(<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEventUser & { member?: <internal>.Member })[]>

- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/methods/GuildScheduledEvent.d.ts:126
Get a list of users attending a specific event

example
const client = new SnowTransfer("TOKEN") const users = await client.guildScheduledEvent.getGuildScheduledEventUsers(guildId, eventId)

Parameters
- guildId: string
  
  The Id of the guild
- eventId: string
  
  The Id of the event
- Optional query: <internal>.GetGuildScheduledEventUsers
Returns Promise<(<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEventUser & { member?: <internal>.Member })[]>
An array of event users

Permissions needed Condition

VIEW_CHANNEL if entity_type is STAGE_INSTANCE or VOICE

Permissions needed	Condition
VIEW_CHANNEL	if entity_type is STAGE_INSTANCE or VOICE

listGuildScheduledEvents

listGuildScheduledEvents(guildId: string, withCounts?: boolean): Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent[]>

- Defined in node_modules/cloudstorm/node_modules/snowtransfer/dist/methods/GuildScheduledEvent.d.ts:26
Get all scheduled events for a guild

example
const client = new SnowTransfer("TOKEN") const events = await client.guildScheduledEvent.listGuildScheduledEvents(guildId)

Parameters
- guildId: string
  
  The Id of the guild
- Optional withCounts: boolean
  
  Include number of users subscribed to each event
Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent[]>
An array of guild scheduled events

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

requestHandler: <internal>.RequestHandler

Returns <internal>.GuildScheduledEventMethods

Properties

requestHandler

Static default

Methods

createGuildScheduledEvent

Parameters

guildId: string

data: CreateGuildScheduledEventData

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

deleteGuildScheduledEvent

Parameters

guildId: string

eventId: string

Returns Promise<void>

editGuildScheduledEvent

Parameters

guildId: string

eventId: string

data: EditGuildScheduledEventData

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

getGuildScheduledEvent

Parameters

guildId: string

eventId: string

Optional withCount: boolean

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent>

getGuildScheduledEventUsers

Parameters

guildId: string

eventId: string

Optional query: <internal>.GetGuildScheduledEventUsers

Returns Promise<(<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEventUser & { member?: <internal>.Member })[]>

listGuildScheduledEvents

Parameters

guildId: string

Optional withCounts: boolean

Returns Promise<<internal>."/home/runner/work/avocord/avocord/node_modules/discord-typings/Resources/GuildScheduledEvent".GuildScheduledEvent[]>