Table of Contents

Interface IInvite

Namespace
Kook
Assembly
Kook.Net.Core.dll

Represents a generic invite.

public interface IInvite : IEntity<uint>, IDeletable
Inherited Members

Properties

Channel

Gets the channel this invite is linked to.

IChannel Channel { get; }

Property Value

IChannel

A generic channel that the invite points to.

ChannelId

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

ulong? ChannelId { get; }

Property Value

ulong?

A ulong representing the channel identifier that the invite points to.

ChannelName

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

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.

ChannelType ChannelType { get; }

Property Value

ChannelType

Code

Gets the unique identifier for this invite.

string Code { get; }

Property Value

string

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

CreatedAt

Gets the time at which this invite was created.

DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

A DateTimeOffset representing the time at which this invite was created.

ExpiresAt

Gets the time at which this invite will expire.

DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

A DateTimeOffset representing the time until this invite expires; null if this invite never expires.

Guild

Gets the guild this invite is linked to.

IGuild Guild { get; }

Property Value

IGuild

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

GuildId

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

ulong? GuildId { get; }

Property Value

ulong?

A ulong representing the guild identifier that the invite points to.

GuildName

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

string GuildName { get; }

Property Value

string

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

InvitedUsersCount

Gets the number of users that have accepted this invite.

int InvitedUsersCount { get; }

Property Value

int

An int representing the number of users that have accepted this invite.

Inviter

Gets the user that created this invite.

IUser Inviter { get; }

Property Value

IUser

A user that created this invite.

MaxAge

Gets the time span until the invite expires.

TimeSpan? MaxAge { get; }

Property Value

TimeSpan?

A TimeSpan representing the time span until this invite expires; null if this invite never expires.

MaxUses

Gets the max number of uses this invite may have.

int? MaxUses { get; }

Property Value

int?

An int representing the number of uses this invite may be accepted until it is removed from the guild; null if none is set.

RemainingUses

Gets the number of times this invite still remains.

int? RemainingUses { get; }

Property Value

int?

An int representing the number of times this invite still remains; null if none is set.

Url

Gets the URL used to accept this invite using Code.

string Url { get; }

Property Value

string

A string containing the full invite URL (e.g. https://kaihei.co/wEAF5t).

Uses

Gets the number of times this invite has been used.

int? Uses { get; }

Property Value

int?

An int representing the number of times this invite has been used; null if none is set.

Edit this page