Table of Contents

Class RestInvite

Namespace
Discord.Rest
Assembly
Discord.Net.Rest.dll
public class RestInvite : RestEntity<string>, IInvite, IEntity<string>, IDeletable, IUpdateable
Inheritance
RestInvite
Implements
Derived
Inherited Members

Properties

Application

Gets the embedded application to open for this voice channel embedded application invite.

public RestApplication Application { get; }

Property Value

RestApplication

A partial IApplication object. null if TargetUserType is not EmbeddedApplication.

ChannelId

Gets the ID of the channel this invite is linked to.

public ulong ChannelId { get; }

Property Value

ulong

An ulong representing the channel snowflake identifier that the invite points to.

ChannelName

Gets the name of the channel this invite is linked to.

public string ChannelName { get; }

Property Value

string

A string containing the name of the channel that the invite points to.

ChannelType

Gets the type of the channel this invite is linked to.

public ChannelType ChannelType { get; }

Property Value

ChannelType

Code

Gets the unique identifier for this invite.

public string Code { get; }

Property Value

string

A string containing the invite code (e.g. FTqNnyS).

ExpiresAt

Gets the expiration date of this invite. null if the invite never expires.

public DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

GuildId

Gets the ID of the guild this invite is linked to.

public ulong? GuildId { get; }

Property Value

ulong?

An ulong representing the guild snowflake identifier that the invite points to.

GuildName

Gets the name of the guild this invite is linked to.

public string GuildName { get; }

Property Value

string

A string containing the name of the guild that the invite points to.

Inviter

Gets the user that created this invite.

public IUser Inviter { get; }

Property Value

IUser

A user that created this invite.

MemberCount

Gets the approximated count of total members in the guild.

public int? MemberCount { get; }

Property Value

int?

An int representing the approximated total member count of the guild that the invite points to; null if one cannot be obtained.

PartialGuild

Gets the guild this invite is linked to.

public PartialGuild PartialGuild { get; }

Property Value

PartialGuild

A partial guild object representing the guild that the invite points to.

PresenceCount

Gets the approximated count of online members in the guild.

public int? PresenceCount { get; }

Property Value

int?

An int representing the approximated online member count of the guild that the invite points to; null if one cannot be obtained.

ScheduledEvent

Gets guild scheduled event data. null if event id was invalid.

public RestGuildEvent ScheduledEvent { get; }

Property Value

RestGuildEvent

TargetUser

Gets the user this invite is linked to via TargetUserType.

public IUser TargetUser { get; }

Property Value

IUser

A user that is linked to this invite.

TargetUserType

Gets the type of the linked TargetUser for this invite.

public TargetUserType TargetUserType { get; }

Property Value

TargetUserType

The type of the linked user that is linked to this invite.

Url

Gets the URL used to accept this invite using Code.

public string Url { get; }

Property Value

string

A string containing the full invite URL (e.g. https://discord.gg/FTqNnyS).

Methods

DeleteAsync(RequestOptions)

Deletes this object and all its children.

public Task DeleteAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task

ToString()

Gets the URL of the invite.

public override string ToString()

Returns

string

A string that resolves to the Url of the invite.

UpdateAsync(RequestOptions)

Updates this object's properties with its current state.

public Task UpdateAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task
Edit this page