Table of Contents

Class SocketSelfUser

Namespace
Kook.WebSocket
Assembly
Kook.Net.WebSocket.dll

表示一个基于网关的当前登录的用户信息。

public class SocketSelfUser : SocketUser, ISelfUser, IUser, IEntity<ulong>, IMentionable, IPresence, IUpdateable
Inheritance
SocketSelfUser
Implements
Inherited Members
Extension Methods

Properties

Avatar

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

public override string Avatar { get; }

Property Value

string

Remarks

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

Banner

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

public override string? Banner { get; }

Property Value

string

Remarks

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

BuffAvatar

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

public override string? BuffAvatar { get; }

Property Value

string

Remarks

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

HasAnnualBuff

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

public override bool? HasAnnualBuff { get; }

Property Value

bool?

Remarks

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

HasBuff

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

public override bool? HasBuff { get; }

Property Value

bool?

Remarks

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

IdentifyNumberValue

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

public override ushort IdentifyNumberValue { get; }

Property Value

ushort

InvitedCount

获取此用户的邀请用户数。

public int InvitedCount { get; }

Property Value

int

IsBanned

获取此用户是否被封禁。

public override bool? IsBanned { get; }

Property Value

bool?

Remarks

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

IsBot

获取此用户是否为 Bot。

public override bool? IsBot { get; }

Property Value

bool?

Remarks

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

IsDenoiseEnabled

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

public override bool? IsDenoiseEnabled { get; }

Property Value

bool?

Remarks

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

IsMobileVerified

获取此用户是否验证了手机号码。

public bool IsMobileVerified { get; }

Property Value

bool

Mobile

获取此用户的手机号码。

public string? Mobile { get; }

Property Value

string

MobilePrefix

获取此用户的手机号码前缀。

public string? MobilePrefix { get; }

Property Value

string

Nameplates

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

public override IReadOnlyCollection<Nameplate> Nameplates { get; }

Property Value

IReadOnlyCollection<Nameplate>

Remarks

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

UserTag

获取此用户的标签信息。

public override UserTag? UserTag { get; }

Property Value

UserTag

Remarks

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

Username

获取此用户的用户名。

public override string Username { get; }

Property Value

string

Methods

StartPlayingAsync(IGame, RequestOptions?)

开始一个新的游戏活动。

public Task StartPlayingAsync(IGame game, RequestOptions? options = null)

Parameters

game IGame

要显示的游戏。

options RequestOptions

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

Returns

Task

一个表示异步开始操作的任务。

Remarks

此操作会使当前用户的资料卡片上显式指定的游戏信息。

StartPlayingAsync(Music, RequestOptions?)

开始一个新的听音乐活动。

public Task StartPlayingAsync(Music music, RequestOptions? options = null)

Parameters

music Music

要播放的音乐。

options RequestOptions

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

Returns

Task

一个表示异步开始操作的任务。

Remarks

此操作会使当前用户的资料卡片上显式指定的音乐信息。

StopPlayingAsync(ActivityType, RequestOptions?)

停止活动。

public Task StopPlayingAsync(ActivityType type, RequestOptions? options = null)

Parameters

type ActivityType

要停止的活动类型。

options RequestOptions

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

Returns

Task

一个表示异步停止操作的任务。

Remarks

此操作会使当前用户的资料卡片上不再显示指定的活动信息。

UpdateAsync(RequestOptions?)

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

public Task UpdateAsync(RequestOptions? options = null)

Parameters

options RequestOptions

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

Returns

Task

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

Remarks

warning

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

Edit this page