Table of Contents

Class RestUser

Namespace
Kook.Rest
Assembly
Kook.Net.Rest.dll

表示一个基于 REST 的用户。

public class RestUser : RestEntity<ulong>, IUser, IEntity<ulong>, IMentionable, IPresence, IUpdateable
Inheritance
RestUser
Implements
Derived
Inherited Members
Extension Methods

Properties

ActiveClient

获取此用于当前登录的客户端类型。

public ClientType? ActiveClient { get; }

Property Value

ClientType?

Avatar

获取此用户的头像图像的 URL。

public string Avatar { get; }

Property Value

string

Remarks

如果此用户为 BUFF 会员，且以 BUFF 会员权益设置了头像，则此属性返回的 URL 表示的是 BUFF 专属头像权益时效后的回退头像。

Banner

获取此用户的横幅图像的 URL。

public string? Banner { get; }

Property Value

string

Remarks

如果此用户不是 BUFF 会员，或未以 BUFF 会员权限设置横幅，则此属性返回 null。

BuffAvatar

获取此用户以 BUFF 会员权益设置的头像图像的 URL。

public string? BuffAvatar { get; }

Property Value

string

Remarks

如果此用户不是 BUFF 会员，或未以 BUFF 会员权限设置头像，则此属性返回 null。

HasAnnualBuff

获取此用户是否订阅了年度 BUFF 会员。

public bool? HasAnnualBuff { get; }

Property Value

bool?

Remarks

如果未知此用户是否订阅了年度 BUFF 会员，则此属性返回 null。

HasBuff

获取此用户是否订阅了 BUFF 会员。

public bool? HasBuff { get; }

Property Value

bool?

Remarks

如果未知此用户是否订阅了 BUFF 会员，则此属性返回 null。

IdentifyNumber

获取此用户的识别号。

public string IdentifyNumber { get; }

Property Value

string

IdentifyNumberValue

获取此用户识别号的数值形式。

public ushort IdentifyNumberValue { get; }

Property Value

ushort

IsBanned

获取此用户是否被封禁。

public bool? IsBanned { get; }

Property Value

bool?

Remarks

如果未知此用户是否被封禁，则此属性返回 null。

IsBot

获取此用户是否为 Bot。

public bool? IsBot { get; }

Property Value

bool?

Remarks

如果未知此用户是否为 Bot，则此属性返回 null。

IsDenoiseEnabled

获取此用户是否启用了降噪功能。

public bool? IsDenoiseEnabled { get; }

Property Value

bool?

Remarks

如果未知此用户是否启用了降噪功能，则此属性返回 null。

IsOnline

获取此用户当前是否在线。

public bool? IsOnline { get; }

Property Value

bool?

IsSystemUser

获取此用户是否为系统用户。

public bool IsSystemUser { get; }

Property Value

bool

KMarkdownMention

返回一个用于在 KMarkdown 格式文本中提及此对象的格式化字符串。

public string KMarkdownMention { get; }

Property Value

string

Nameplates

获取此用户设置展示的所有铭牌。

public IReadOnlyCollection<Nameplate> Nameplates { get; }

Property Value

IReadOnlyCollection<Nameplate>

Remarks

用户设置的首个铭牌会展示在该用户聊天消息的用户名的右侧，用户设置的所有铭牌会展示在个人信息面板内的用户名下方。

PlainTextMention

获取一个用于在纯文本格式文本中提及此对象的格式化字符串。

public string PlainTextMention { get; }

Property Value

string

UserTag

获取此用户的标签信息。

public UserTag? UserTag { get; }

Property Value

UserTag

Remarks

用户的标签会显示在服务器用户列表、私信列表、私信消息页、好友列表、个人信息面板、聊天消息的用户名的右侧。
如果此用户没有标签，或未知此用户的标签信息，则此属性返回 null。

Username

获取此用户的用户名。

public string Username { get; }

Property Value

string

Methods

BlockAsync(RequestOptions?)

屏蔽此用户。

public Task BlockAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步屏蔽操作的任务。

CreateDMChannelAsync(RequestOptions?)

创建一个用于与此用户收发私信的频道。

public Task<RestDMChannel> CreateDMChannelAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestDMChannel>

一个表示异步创建操作的任务。任务结果包含与此用户相关的私信频道。

GetIntimacyAsync(RequestOptions?)

获取与此用户的亲密度信息。

public Task<RestIntimacy> GetIntimacyAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task<RestIntimacy>

一个表示异步获取操作的任务。任务结果包含与此用户的亲密度信息。

RemoveFriendAsync(RequestOptions?)

移除与此用户的好友关系。

public Task RemoveFriendAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步移除操作的任务。

RequestFriendAsync(RequestOptions?)

向此用户发送好友请求。

public virtual Task RequestFriendAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步发送操作的任务。

ToString()

获取此用户的包含用户名及识别号的格式化字符串。

public override string ToString()

Returns

string

一个表示此用户的包含用户名及识别号的格式化字符串。

See Also

UnblockAsync(RequestOptions?)

取消屏蔽此用户。

public Task UnblockAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步取消操作的任务。

UpdateAsync(RequestOptions?)

通过 REST API 获取此实体对象的最新状态，并替换当前对象的属性。

public virtual Task UpdateAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

一个表示异步更新操作的任务。

Remarks

warning

此方法将从 KOOK REST API 获取最新数据，并替换当前对象的属性，而非使用指定的属性修改 KOOK 服务端的数据。

UpdateIntimacyAsync(Action<IntimacyProperties>, RequestOptions?)

修改与此用户的亲密度信息。

public Task UpdateIntimacyAsync(Action<IntimacyProperties> func, RequestOptions? options = null)

Parameters

func Action<IntimacyProperties>

一个用于修改亲密度信息的委托。

options RequestOptions

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

Returns

Task

一个表示异步修改操作的任务。

Remarks

此方法使用指定的属性修改与此用户的亲密度信息。要查看可用的属性，请参考 IntimacyProperties。

Edit this page