Interface IRoomUser

Namespace

HeyBox

Assembly

HeyBox.Net.Core.dll

表示一个通用的房间用户。

public interface IRoomUser : IUser, IEntity<uint>, IMentionable

Inherited Members

IUser.Username

IUser.IsBot

IUser.Avatar

IUser.AvatarDecorationType

IUser.AvatarDecorationUrl

IUser.Level

IUser.CreateDMChannel()

IEntity<uint>.Id

IEntity<uint>.IsPopulated

IMentionable.Mention

Properties

DisplayName

获取此用户的显示名称。

string? DisplayName { get; }

Property Value

string

Remarks

如果此用户在该房间内设置了昵称，则此属性返回昵称；否则返回用户名。

Nickname

获取此用户在该房间内的昵称。

string? Nickname { get; }

Property Value

string

Remarks

如果此用户在该房间内没有设置昵称，则此属性返回 null。

RoleIds

获取此用户在该房间内拥有的所有角色的 ID。

IReadOnlyCollection<ulong> RoleIds { get; }

Property Value

IReadOnlyCollection<ulong>

Room

获取此房间用户所属的房间。

IRoom Room { get; }

Property Value

IRoom

RoomId

获取此用户所属房间的 ID。

ulong RoomId { get; }

Property Value

ulong

RoomPermissions

获取此用户在该房间内的权限。

RoomPermissions RoomPermissions { get; }

Property Value

RoomPermissions

Methods

AddRoleAsync(IRole, RequestOptions?)

在该房间内授予此用户指定的角色。

Task AddRoleAsync(IRole role, RequestOptions? options = null)

Parameters

role IRole

要在该房间内为此用户授予的角色。

options RequestOptions

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

Returns

Task

一个表示异步授予操作的任务。

AddRoleAsync(ulong, RequestOptions?)

在该房间内授予此用户指定的角色。

Task AddRoleAsync(ulong roleId, RequestOptions? options = null)

Parameters

roleId ulong

要在该房间内为此用户授予的角色的 ID。

options RequestOptions

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

Returns

Task

一个表示异步授予操作的任务。

AddRolesAsync(IEnumerable<IRole>, RequestOptions?)

在该房间内授予此用户指定的一些角色。

Task AddRolesAsync(IEnumerable<IRole> roles, RequestOptions? options = null)

Parameters

roles IEnumerable<IRole>

要在该房间内为此用户授予的所有角色。

options RequestOptions

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

Returns

Task

一个表示异步授予操作的任务。

AddRolesAsync(IEnumerable<ulong>, RequestOptions?)

在该房间内授予此用户指定的一些角色。

Task AddRolesAsync(IEnumerable<ulong> roleIds, RequestOptions? options = null)

Parameters

roleIds IEnumerable<ulong>

要在该房间内为此用户授予的所有角色的 ID。

options RequestOptions

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

Returns

Task

一个表示异步授予操作的任务。

GetPermissions(IRoomChannel)

获取此用户在指定频道内所拥有的权限。

ChannelPermissions GetPermissions(IRoomChannel channel)

Parameters

channel IRoomChannel

要获取权限的频道。

Returns

ChannelPermissions

一个表示此用户在指定频道内所拥有的频道权限的权限集。

RemoveRoleAsync(IRole, RequestOptions?)

在该房间内撤销此用户指定的角色。

Task RemoveRoleAsync(IRole role, RequestOptions? options = null)

Parameters

role IRole

要在该房间内为此用户撤销的角色。

options RequestOptions

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

Returns

Task

一个表示异步撤销操作的任务。

RemoveRoleAsync(ulong, RequestOptions?)

在该房间内撤销此用户指定的角色。

Task RemoveRoleAsync(ulong roleId, RequestOptions? options = null)

Parameters

roleId ulong

要在该房间内为此用户撤销的角色的 ID。

options RequestOptions

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

Returns

Task

一个表示异步撤销操作的任务。

RemoveRolesAsync(IEnumerable<IRole>, RequestOptions?)

在该房间内撤销此用户指定的一些角色。

Task RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions? options = null)

Parameters

roles IEnumerable<IRole>

要在该房间内为此用户撤销的所有角色。

options RequestOptions

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

Returns

Task

一个表示异步撤销操作的任务。

RemoveRolesAsync(IEnumerable<ulong>, RequestOptions?)

在该房间内撤销此用户指定的一些角色。

Task RemoveRolesAsync(IEnumerable<ulong> roleIds, RequestOptions? options = null)

Parameters

roleIds IEnumerable<ulong>

要在该房间内为此用户撤销的所有角色的 ID。

options RequestOptions

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

Returns

Task

一个表示异步撤销操作的任务。