Method GetUsersAsync

Namespace

DisCatSharp.Entities

Assembly

DisCatSharp.dll

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

Gets users subscribed to this scheduled event exception.

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 maximum number of users to return.

before ulong?

Get users before this user id.

after ulong?

Get users after this user id.

withMember bool?

Whether to include guild member data.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task<IReadOnlyDictionary<ulong, DiscordScheduledEventUser>>

A map of subscribed users by user id.

Exceptions

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.