Method GetInviteByCodeAsync

Namespace: DisCatSharp

Assembly: DisCatSharp.dll

GetInviteByCodeAsync(string, bool?, ulong?, bool?, CancellationToken)

Gets an invite.

public Task<DiscordInvite> GetInviteByCodeAsync(string code, bool? withCounts = null, ulong? scheduledEventId = null, bool? withPermissions = null, CancellationToken cancellationToken = default)

Parameters

code string: The invite code.
withCounts bool?: Whether to include presence and total member counts in the returned invite.
scheduledEventId ulong?: The scheduled event id.
withPermissions bool?: Whether to include the invite's permissions.
cancellationToken CancellationToken: A token to cancel the request.

Returns

Task<DiscordInvite>: The requested invite.

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.