API reference

Method BulkDeleteInviteTargetUsersAsync

Namespace

DisCatSharp

Assembly

DisCatSharp.dll

BulkDeleteInviteTargetUsersAsync(string, IEnumerable<ulong>, CancellationToken)

Bulk removes target users from an existing invite.

public Task BulkDeleteInviteTargetUsersAsync(string inviteCode, IEnumerable<ulong> targetUserIds, CancellationToken cancellationToken = default)

Parameters

inviteCode string

The invite code.

targetUserIds IEnumerable<ulong>

The user ids to remove.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

ArgumentException

Thrown when no valid users are provided or more than 1,000 distinct users are provided.

NotFoundException

Thrown when the invite does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.

BulkDeleteInviteTargetUsersAsync(string, IEnumerable<DiscordUser>, CancellationToken)

Removes multiple target users from an existing invite.

public Task BulkDeleteInviteTargetUsersAsync(string inviteCode, IEnumerable<DiscordUser> targetUsers, CancellationToken cancellationToken = default)

Parameters

inviteCode string

The invite code.

targetUsers IEnumerable<DiscordUser>

The users to remove.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

ArgumentException

Thrown when no valid users are provided or more than 1,000 distinct users are provided.

NotFoundException

Thrown when the invite does not exist.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.