Method UpdateInviteTargetUsersAsync

Namespace

DisCatSharp

Assembly

DisCatSharp.dll

UpdateInviteTargetUsersAsync(string, Stream, string, CancellationToken)

Updates the target users allowed to accept an invite using a CSV stream.

public Task UpdateInviteTargetUsersAsync(string inviteCode, Stream targetUsersCsv, string reason = null, CancellationToken cancellationToken = default)

Parameters

inviteCode string

The invite code.

targetUsersCsv Stream

CSV stream containing a single Users column. The CSV must have a header row where the first (and only) column header is Users, and each subsequent line must contain exactly one user ID.

reason string

The audit log reason.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

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.

UpdateInviteTargetUsersAsync(string, IEnumerable<ulong>, string, CancellationToken)

Updates the target users allowed to accept an invite using user ids.

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

Parameters

inviteCode string

The invite code.

targetUserIds IEnumerable<ulong>

User ids allowed to accept the invite.

reason string

The audit log reason.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

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.

UpdateInviteTargetUsersAsync(string, IEnumerable<DiscordUser>, string, CancellationToken)

Updates the target users allowed to accept an invite using user objects.

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

Parameters

inviteCode string

The invite code.

targetUsers IEnumerable<DiscordUser>

Users allowed to accept the invite.

reason string

The audit log reason.

cancellationToken CancellationToken

A token to cancel the request.

Returns

Task

Exceptions

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.