Class SocketInvite

Namespace

Kook.WebSocket

Assembly

Kook.Net.WebSocket.dll

表示一个基于网关的邀请。

public class SocketInvite : SocketEntity<uint>, IInvite, IEntity<uint>, IDeletable

Inheritance

object

SocketEntity<uint>

SocketInvite

Implements

IInvite

IEntity<uint>

IDeletable

Inherited Members

SocketEntity<uint>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Channel

获取此邀请链接指向的频道。

public SocketGuildChannel Channel { get; }

Property Value

SocketGuildChannel

ChannelId

获取此邀请链接指向的频道的 ID。

public ulong? ChannelId { get; }

Property Value

ulong?

Code

获取此邀请的唯一代码。

public string Code { get; }

Property Value

string

CreatedAt

获取此邀请的创建时间。

public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

ExpiresAt

获取此邀请的过期时间。

public DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

Remarks

如果此邀请永不过期，则此属性的值为 null。

Guild

获取此邀请链接指向的服务器。

public SocketGuild Guild { get; }

Property Value

SocketGuild

GuildId

获取此邀请链接指向的服务器的 ID。

public ulong? GuildId { get; }

Property Value

ulong?

InvitedUsersCount

获取已接受此邀请的用户数量。

public int InvitedUsersCount { get; }

Property Value

int

Inviter

获取创建此邀请的用户。

public SocketGuildUser Inviter { get; }

Property Value

SocketGuildUser

MaxAge

获取此邀请的有效时长。

public TimeSpan? MaxAge { get; }

Property Value

TimeSpan?

Remarks

如果此邀请永不过期，则此属性的值为 null。

MaxUses

获取此邀请的可用人次。

public int? MaxUses { get; }

Property Value

int?

Remarks

如果此邀请不限制可用人次，则此属性的值为 null。

RemainingUses

获取此邀请剩余可用次数。

public int? RemainingUses { get; }

Property Value

int?

Remarks

如果此邀请不限制可用人次，则此属性的值为 null。

Url

获取用于接受此邀请的 URL，URL 的路径中包含 Code 属性的值。

public string Url { get; }

Property Value

string

Uses

获取此邀请已被使用的次数。

public int? Uses { get; }

Property Value

int?

Methods

DeleteAsync(RequestOptions?)

删除此对实体象及其所有子实体对象。

public Task DeleteAsync(RequestOptions? options = null)

Parameters

options RequestOptions

发送请求时要使用的选项。

Returns

Task

ToString()

获取用于接受此邀请的 URL，URL 的路径中包含 Code 属性的值。

public override string ToString()

Returns

string