Method GetScheduledEventAsync

Namespace

DisCatSharp.Entities

Assembly

DisCatSharp.dll

GetScheduledEventAsync(ulong, bool?, CancellationToken)

Gets a specific scheduled events.

public Task<DiscordScheduledEvent> GetScheduledEventAsync(ulong scheduledEventId, bool? withUserCount = null, CancellationToken cancellationToken = default)

Parameters

scheduledEventId ulong

The Id of the event to get.

withUserCount bool?

Whether to include user count.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<DiscordScheduledEvent>

A scheduled event.

Exceptions

NotFoundException

Thrown when the guild does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.

GetScheduledEventAsync(DiscordScheduledEvent, bool?, CancellationToken)

Gets a specific scheduled events.

public Task<DiscordScheduledEvent> GetScheduledEventAsync(DiscordScheduledEvent scheduledEvent, bool? withUserCount = null, CancellationToken cancellationToken = default)

Parameters

scheduledEvent DiscordScheduledEvent

The event to get.

withUserCount bool?

Whether to include user count.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<DiscordScheduledEvent>

A scheduled event.

Exceptions

NotFoundException

Thrown when the guild does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.