Table of Contents

Method GetUsersAsync

Namespace
DisCatSharp.Entities
Assembly
DisCatSharp.dll

GetUsersAsync(int?, ulong?, ulong?, bool?, CancellationToken)

Gets a list of users RSVP'd to the scheduled event.

public Task<IReadOnlyDictionary<ulong, DiscordScheduledEventUser>> GetUsersAsync(int? limit = null, ulong? before = null, ulong? after = null, bool? withMember = null, CancellationToken cancellationToken = default)

Parameters

limit int?

The limit how many users to receive from the event. Defaults to 100. Max 100.

before ulong?

Get results of DiscordScheduledEventUser before the given snowflake.

after ulong?

Get results of DiscordScheduledEventUser after the given snowflake.

withMember bool?

Whether to include guild member data.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<IReadOnlyDictionary<ulong, DiscordScheduledEventUser>>

Exceptions

UnauthorizedException

Thrown when the client does not have the correct permissions.

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.