Skip to main content

Class RestInvite

Assembly: Discord.Net.Rest.dll​
View Source​
Declaration
public class RestInvite : RestEntity<string>, IInvite, IEntity<string>, IDeletable, IUpdateable

Properties​

ChannelType​

View Source​
Declaration
public ChannelType ChannelType { get; }

ChannelName​

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

View Source​
Declaration
public string ChannelName { get; }

GuildName​

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

View Source​
Declaration
public string GuildName { get; }

PresenceCount​

Gets the approximated count of online members in the guild.

View Source​
Declaration
public int? PresenceCount { get; }

MemberCount​

Gets the approximated count of total members in the guild.

View Source​
Declaration
public int? MemberCount { get; }

ChannelId​

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

View Source​
Declaration
public ulong ChannelId { get; }

GuildId​

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

View Source​
Declaration
public ulong? GuildId { get; }

Inviter​

Gets the user that created this invite.

View Source​
Declaration
public IUser Inviter { get; }

TargetUser​

Gets the user this invite is linked to via Discord.IInvite.TargetUserType.

View Source​
Declaration
public IUser TargetUser { get; }

TargetUserType​

Gets the type of the linked Discord.IInvite.TargetUser for this invite.

View Source​
Declaration
public TargetUserType TargetUserType { get; }

Code​

Gets the unique identifier for this invite.

View Source​
Declaration
public string Code { get; }

Url​

Gets the URL used to accept this invite using Discord.IInvite.Code.

View Source​
Declaration
public string Url { get; }

IInvite.Guild​

Gets the guild this invite is linked to.

View Source​
Declaration
IGuild IInvite.Guild { get; }

IInvite.Channel​

Gets the channel this invite is linked to.

View Source​
Declaration
IChannel IInvite.Channel { get; }

Methods​

UpdateAsync(RequestOptions)​

Updates this object's properties with its current state.

View Source​
Declaration
public async Task UpdateAsync(RequestOptions options = null)
Returns​

System.Threading.Tasks.Task

Parameters​
TypeNameDescription
Discord.RequestOptionsoptionsThe options to be used when sending the request.

DeleteAsync(RequestOptions)​

Deletes this object and all its children.

View Source​
Declaration
public Task DeleteAsync(RequestOptions options = null)
Returns​

System.Threading.Tasks.Task

Parameters​
TypeNameDescription
Discord.RequestOptionsoptionsThe options to be used when sending the request.

ToString()​

Gets the URL of the invite.

View Source​
Declaration
public override string ToString()
Returns​

System.String: A string that resolves to the Url of the invite.

Implements​