Method StartAsync

Namespace

DisCatSharp.Entities

Assembly

DisCatSharp.dll

StartAsync(string, CancellationToken)

Starts the current scheduled event.

public Task<DiscordScheduledEvent> StartAsync(string reason = null, CancellationToken cancellationToken = default)

Parameters

reason string

The audit log reason.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<DiscordScheduledEvent>

Exceptions

UnauthorizedException

Thrown when the client does not have the ManageEvents permission.

NotFoundException

Thrown when the event does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.