GuildScheduledEvent

HTTP Rest API implementation for the following Resource:

• https://discord.com/developers/docs/resources/guild-scheduled-event

Summary

Functions

GuildScheduledEvent.listScheduledEventsForGuildAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { withUserCount: boolean?, }) → future.FutureLike< string, apiTypes.ListScheduledEventsForGuildResponse >GuildScheduledEvent.createGuildScheduledEventAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.CreateGuildScheduledEventRequest, auditLogReason: string?) → future.FutureLike< string, apiTypes.CreateGuildScheduledEventResponse >GuildScheduledEvent.getScheduledEventsForGuildAsync(instance: request.Request, guildId: apiTypes.Snowflake, scheduledEventId: apiTypes.Snowflake, urlParams: { withUserCount: boolean?, }) → future.FutureLike< string, apiTypes.GetGuildScheduledEventResponse >GuildScheduledEvent.modifyGuildScheduledEventAsync(instance: request.Request, guildId: apiTypes.Snowflake, scheduledEventId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildScheduledEventRequest, auditLogReason: string?) → future.FutureLike< string, apiTypes.ModifyGuildScheduledEventResponse >GuildScheduledEvent.deleteGuildScheduledEventAsync(instance: request.Request, guildId: apiTypes.Snowflake, scheduledEventId: apiTypes.Snowflake) → future.FutureLike< string, apiTypes.DeleteGuildScheduledEventResponse >GuildScheduledEvent.getGuildScheduledEventUsersAsync(instance: request.Request, guildId: apiTypes.Snowflake, scheduledEventId: apiTypes.Snowflake) → future.FutureLike< string, apiTypes.GetGuildScheduledEventUsersResponse >

Functions

listScheduledEventsForGuildAsync

GuildScheduledEvent . listScheduledEventsForGuildAsync ( instance ,  guildId ,  urlParams )  -> FutureLike< string, ListScheduledEventsForGuildResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

Parameters

instance: Request
guildId: Snowflake
urlParams: { { withUserCount: boolean?, } }

Returns

FutureLike<string, ListScheduledEventsForGuildResponse>

createGuildScheduledEventAsync

GuildScheduledEvent . createGuildScheduledEventAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike< string, CreateGuildScheduledEventResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

Parameters

instance: Request
guildId: Snowflake
jsonParams: CreateGuildScheduledEventRequest
auditLogReason: string?

Returns

FutureLike<string, CreateGuildScheduledEventResponse>

getScheduledEventsForGuildAsync

GuildScheduledEvent . getScheduledEventsForGuildAsync ( instance ,  guildId ,  scheduledEventId ,  urlParams )  -> FutureLike< string, GetGuildScheduledEventResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

Parameters

instance: Request
guildId: Snowflake
scheduledEventId: Snowflake
urlParams: { { withUserCount: boolean?, } }

Returns

FutureLike<string, GetGuildScheduledEventResponse>

modifyGuildScheduledEventAsync

GuildScheduledEvent . modifyGuildScheduledEventAsync ( instance ,  guildId ,  scheduledEventId ,  jsonParams ,  auditLogReason )  -> FutureLike< string, ModifyGuildScheduledEventResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

Parameters

instance: Request
guildId: Snowflake
scheduledEventId: Snowflake
jsonParams: ModifyGuildScheduledEventRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildScheduledEventResponse>

deleteGuildScheduledEventAsync

GuildScheduledEvent . deleteGuildScheduledEventAsync ( instance ,  guildId ,  scheduledEventId )  -> FutureLike< string, DeleteGuildScheduledEventResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

Parameters

instance: Request
guildId: Snowflake
scheduledEventId: Snowflake

Returns

FutureLike<string, DeleteGuildScheduledEventResponse>

getGuildScheduledEventUsersAsync

GuildScheduledEvent . getGuildScheduledEventUsersAsync ( instance ,  guildId ,  scheduledEventId )  -> FutureLike< string, GetGuildScheduledEventUsersResponse >

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users

Parameters

instance: Request
guildId: Snowflake
scheduledEventId: Snowflake

Returns

FutureLike<string, GetGuildScheduledEventUsersResponse>