Class GuildScheduledEventManager

Hierarchy

GuildScheduledEventManager

Index

Constructors

constructor

Methods

Properties

Constructors

constructor

new GuildScheduledEventManager(token: string, tokenType: string, version: APIVersions): GuildScheduledEventManager

- Defined in client/managers/GuildScheduledEventManager.ts:55
Parameters
- token: string
  
  Bot's token
- tokenType: string
- version: APIVersions
  
  API Version
Returns GuildScheduledEventManager

Methods

createScheduledEvent

createScheduledEvent(guildId: string, options: CreateScheduleEventOptions, reason?: string): Promise<GuildScheduledEvent>

- Defined in client/managers/GuildScheduledEventManager.ts:92
Create a scheduled event

Parameters
- guildId: string
  
  Guild ID
- options: CreateScheduleEventOptions
  
  Scheduled event option
- Optional reason: string
Returns Promise<GuildScheduledEvent>
Scheduled event

deleteScheduledEvent

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

- Defined in client/managers/GuildScheduledEventManager.ts:174
Delete a scheduled event

Parameters
- guildId: string
  
  Guild ID
- eventId: string
  
  Scheduled event ID
Returns Promise<void>

getScheduledEvent

getScheduledEvent(guildId: string, eventId: string, options?: GetScheduleEventsOptions): Promise<GuildScheduledEvent>

- Defined in client/managers/GuildScheduledEventManager.ts:119
Get a scheduled event

Parameters
- guildId: string
  
  Guild ID
- eventId: string
  
  Scheduled event ID
- options: GetScheduleEventsOptions = {}
Returns Promise<GuildScheduledEvent>
Scheduled event

getScheduledEventUsers

getScheduledEventUsers(guildId: string, eventId: string, options?: GetScheduledEventUsersOptions): Promise<GuildScheduledEventUser[]>

- Defined in client/managers/GuildScheduledEventManager.ts:198
Get guild scheduled event users

Parameters
- guildId: string
  
  Guild ID
- eventId: string
  
  Scheduled event ID
- options: GetScheduledEventUsersOptions = {}
  
  Query
Returns Promise<GuildScheduledEventUser[]>
List of users

listScheduledEvents

listScheduledEvents(guildId: string, query?: GetScheduleEventsOptions): Promise<GuildScheduledEvent[]>

- Defined in client/managers/GuildScheduledEventManager.ts:67
List sheduled events for a guild

Parameters
- guildId: string
  
  Guild ID
- query: GetScheduleEventsOptions = {}
  
  Query
Returns Promise<GuildScheduledEvent[]>
List of scheduled events

modifyScheduledEvent

modifyScheduledEvent(guildId: string, eventId: string, options: CreateScheduleEventOptions, reason?: string): Promise<GuildScheduledEvent>

- Defined in client/managers/GuildScheduledEventManager.ts:147
Modify a scheduled event

Parameters
- guildId: string
  
  Guild ID
- eventId: string
  
  Scheduled event ID
- options: CreateScheduleEventOptions
  
  Scheduled event options
- Optional reason: string
  
  Modification reason
Returns Promise<GuildScheduledEvent>
Scheduled event

Properties

Readonly version

version: APIVersions

API Version

Private #token

#token: string

Bot's token

Private Readonly #tokenType

#tokenType: string

Token type

Generated using TypeDoc