Class SocketGuild
表示一个基于网关的服务器。
public class SocketGuild : SocketEntity<ulong>, IGuild, IEntity<ulong>, IDisposable, IUpdateable
- Inheritance
-
SocketGuild
- Implements
- Inherited Members
Properties
ActiveBoostSubscriptions
获取此服务器内的所有生效中的服务器助力信息。
public ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>> ActiveBoostSubscriptions { get; }
Property Value
Remarks
warning
当 AlwaysDownloadBoostSubscriptions 为 true
时,Bot 启动时会自动下载所有服务器的所有助力信息。否则,此属性将为 null
。调用
DownloadBoostSubscriptionsAsync(RequestOptions?)
也可以立即下载服务器的所有助力信息,下载完成后,此属性值将被设定。
网关不会发布有关此属性值变更的事件,此属性值可能并不准确。要获取准确的服务器订阅信息,请调用
GetActiveBoostSubscriptionsAsync(RequestOptions?)。
AudioClient
获取在此服务内的语音频道上建立的语音客户端。
[Obsolete("Use AudioClients instead.")]
public IAudioClient? AudioClient { get; }
Property Value
- See Also
AudioClients
获取在此服务内的语音频道上建立的所有语音客户端。
public IReadOnlyDictionary<ulong, IAudioClient> AudioClients { get; }
Property Value
- See Also
AutoDeleteTime
TODO: To be documented.
public string? AutoDeleteTime { get; }
Property Value
Banner
获取此服务器横幅图像的 URL。
public string Banner { get; }
Property Value
BoostLevel
获取此服务器的服务器助力等级。
public BoostLevel BoostLevel { get; }
Property Value
BoostSubscriptionCount
获取此服务器的服务器助力包的数量。
public int BoostSubscriptionCount { get; }
Property Value
BoostSubscriptions
获取此服务器内的所有服务器助力信息。
public ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>> BoostSubscriptions { get; }
Property Value
Remarks
warning
当 AlwaysDownloadBoostSubscriptions 为 true
时,Bot 启动时会自动下载所有服务器的所有助力信息。否则,此属性将为 null
。调用
DownloadBoostSubscriptionsAsync(RequestOptions?)
也可以立即下载服务器的所有助力信息,下载完成后,此属性值将被设定。
网关不会发布有关此属性值变更的事件,此属性值可能并不准确。要获取准确的服务器订阅信息,请调用
GetBoostSubscriptionsAsync(RequestOptions?)。
BufferBoostSubscriptionCount
获取此服务器来自拥有 BUFF 会员的用的服务器助力包的数量。
public int BufferBoostSubscriptionCount { get; }
Property Value
CategoryChannels
获取此服务器中的所有分组频道。
public IReadOnlyCollection<SocketCategoryChannel> CategoryChannels { get; }
Property Value
Channels
获取此服务器的所有频道。
public IReadOnlyCollection<SocketGuildChannel> Channels { get; }
Property Value
CurrentUser
获取当前登录的用户。
public SocketGuildUser? CurrentUser { get; }
Property Value
DefaultChannel
获取此服务器的默认文字频道。
public SocketTextChannel? DefaultChannel { get; }
Property Value
DefaultChannelId
获取默认文字频道的 ID。
public ulong? DefaultChannelId { get; }
Property Value
DownloadedMemberCount
获取此服务器内已缓存的成员数量。
public int DownloadedMemberCount { get; }
Property Value
Emotes
获取此服务器的所有自定义表情。
public IReadOnlyCollection<GuildEmote> Emotes { get; }
Property Value
EveryoneRole
获取此服务器中的 @全体成员
全体成员角色。
public SocketRole EveryoneRole { get; }
Property Value
Features
获取此服务器的所有特性。
public GuildFeatures Features { get; }
Property Value
HasAllMembers
获取是否已下载此服务器的所有成员至缓存。
public bool? HasAllMembers { get; }
Property Value
- bool?
Remarks
当如法确定是否已下载此服务器的所有成员,或者服务器的成员数量未知时,此属性将返回 null
。
Icon
获取此服务器图标的 URL。
public string Icon { get; }
Property Value
IsAvailable
确定此服务器实体是否已准备就绪以供用户代码访问。
public bool IsAvailable { get; }
Property Value
Remarks
note
此属性仅对基于网关连接的客户端有意义。
true
表示,此服务器实体已完整缓存基础数据,并与网关同步。 缓存基础数据包括服务器基本信息、频道、角色、频道权限重写、当前用户在服务器内的昵称。
IsConnected
获取此服务器是否已连接至网关。
public bool IsConnected { get; }
Property Value
IsOpenEnabled
获取此服务器是否为公开服务器。
public bool IsOpenEnabled { get; }
Property Value
MaxBitrate
获取此服务器中语音频道的最高比特率。
public int MaxBitrate { get; }
Property Value
Remarks
此限制取决于服务器的助力状态。
MaxUploadLimit
获取此服务器的文件上传限制,以字节为单位。
public ulong MaxUploadLimit { get; }
Property Value
Remarks
此限制取决于服务器的助力状态。
MemberCount
获取此服务器的成员数。
public int? MemberCount { get; }
Property Value
- int?
Remarks
tip
在 Users 属性上计数的结果为所缓存用户的数量, 如果缓存不完整,统计结果可能会与此属性值不一致。
warning
当 AlwaysDownloadUsers 为 true
时。
Bot 启动后会自动下载服务器的所有用户,并设定此属性值。否则,此属性将为 null
。调用
DownloadUsersAsync(RequestOptions?)
也可以立即下载服务器的所有用户,下载完成后,此属性值将被设定。
Name
获取此服务器的名称。
public string Name { get; }
Property Value
NotifyType
获取此服务器的默认通知类型。
public NotifyType NotifyType { get; }
Property Value
OpenId
获取此服务器的公开 ID。
public uint? OpenId { get; }
Property Value
- uint?
Remarks
当 IsOpenEnabled 为 true
时,此属性应该返回一个有效的公开服务器 ID;
如果 IsOpenEnabled 为 false
,则此属性应该返回 null
。
Owner
获取此服务器的所有者。
public SocketGuildUser? Owner { get; }
Property Value
Remarks
warning
此属性尝试在缓存的用户列表中获取具有其用户 ID 为 OwnerId
的用户。如果该用户不在缓存中,则此属性将返回 null
。
OwnerId
获取此服务器所有者的用户 ID。
public ulong OwnerId { get; }
Property Value
RecommendInfo
获取此服务器的推荐信息。
public RecommendInfo? RecommendInfo { get; }
Property Value
Region
获取此服务器的默认语音服务器区域。
public string Region { get; }
Property Value
Remarks
语音服务器区域是指语音服务器所在的地理位置,各个语音服务器区域由一个唯一的字符串表示。
可用语音服务器区域参考列表:
区域 ID | 区域名称 |
---|---|
chengdu | 西南(成都) |
beijing | 华北(北京) |
shanghai | 华东(上海) |
shenzhen | 华南(深圳) |
hk | 亚太(香港) |
vnga | 国际专线(助力专享) |
Roles
获取此服务器的所有角色。
public IReadOnlyCollection<SocketRole> Roles { get; }
Property Value
Remarks
warning
由于 KOOK 不会通过网关发布有关服务器角色重新排序的事件,此属性值可能并不准确。 要确保获取准确的服务器角色排序信息,请在使用此属性之前调用 UpdateAsync(RequestOptions?)。
Status
TODO: To be documented.
public int Status { get; }
Property Value
TextChannels
获取此服务器中所有具有文字聊天能力的频道。
public IReadOnlyCollection<SocketTextChannel> TextChannels { get; }
Property Value
Remarks
语音频道也是一种文字频道,此属性本意用于获取所有具有文字聊天能力的频道,通过此方法获取到的文字频道列表中也包含了语音频道。 如需获取频道的实际类型,请参考 GetChannelType(IChannel)。
Topic
获取此服务器的介绍。
public string Topic { get; }
Property Value
Users
获取此服务器内缓存的所有用户。
public IReadOnlyCollection<SocketGuildUser> Users { get; }
Property Value
Remarks
要获取服务器的总成员数量,请访问 MemberCount。
VoiceChannels
获取此服务器中所有具有语音聊天能力的频道。
public IReadOnlyCollection<SocketVoiceChannel> VoiceChannels { get; }
Property Value
WelcomeChannel
获取此服务器的欢迎通知频道。
public SocketTextChannel? WelcomeChannel { get; }
Property Value
WelcomeChannelId
获取欢迎通知频道的 ID。
public ulong? WelcomeChannelId { get; }
Property Value
Methods
AddBanAsync(IUser, int, string?, RequestOptions?)
封禁服务器内的用户。
public Task AddBanAsync(IUser user, int pruneDays = 0, string? reason = null, RequestOptions? options = null)
Parameters
user
IUser要封禁的用户。
pruneDays
int要删除此服务器中来自此用户的最近几天的消息,范围为
0
至7
,0
表示不删除。reason
string封禁原因。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步封禁操作的任务。
Exceptions
- ArgumentException
pruneDays
超出了 0 至 7 的范围。
AddBanAsync(ulong, int, string?, RequestOptions?)
封禁服务器内的用户。
public Task AddBanAsync(ulong userId, int pruneDays = 0, string? reason = null, RequestOptions? options = null)
Parameters
userId
ulong要封禁的用户的 ID。
pruneDays
int要删除此服务器中来自此用户的最近几天的消息,范围为
0
至7
,0
表示不删除。reason
string封禁原因。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步封禁操作的任务。
Exceptions
- ArgumentException
pruneDays
超出了 0 至 7 的范围。
CreateCategoryChannelAsync(string, Action<CreateCategoryChannelProperties>?, RequestOptions?)
在此服务器内创建一个新的分组频道。
public Task<RestCategoryChannel> CreateCategoryChannelAsync(string name, Action<CreateCategoryChannelProperties>? func = null, RequestOptions? options = null)
Parameters
name
string频道的名称。
func
Action<CreateCategoryChannelProperties>一个包含要应用到新创建频道的配置的委托。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<RestCategoryChannel>
一个表示异步创建操作的任务。任务的结果包含新创建的分组频道。
CreateEmoteAsync(string, Image, RequestOptions?)
在此服务器内创建一个新的自定义表情。
public Task<GuildEmote> CreateEmoteAsync(string name, Image image, RequestOptions? options = null)
Parameters
name
string新自定义表情的名称。
image
Image新自定义表情的图像信息。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<GuildEmote>
一个表示异步创建操作的任务。任务的结果包含新创建的自定义表情。
CreateInviteAsync(InviteMaxAge, InviteMaxUses, RequestOptions?)
创建一个到此服务器的新邀请。
public Task<IInvite> CreateInviteAsync(InviteMaxAge maxAge = InviteMaxAge._604800, InviteMaxUses maxUses = InviteMaxUses.Unlimited, RequestOptions? options = null)
Parameters
maxAge
InviteMaxAge邀请链接的有效时长,NeverExpires 表示永不过期。
maxUses
InviteMaxUses邀请链接的可用人次,Unlimited 表示无限制。
options
RequestOptions发送请求时要使用的选项。
Returns
CreateInviteAsync(int?, int?, RequestOptions?)
创建一个到此服务器的新邀请。
public Task<IInvite> CreateInviteAsync(int? maxAge = 604800, int? maxUses = null, RequestOptions? options = null)
Parameters
maxAge
int?邀请链接的有效时长,
null
表示永不过期。maxUses
int?邀请链接的可用人次,
null
表示无限制。options
RequestOptions发送请求时要使用的选项。
Returns
CreateRoleAsync(string, RequestOptions?)
在此服务器内创建一个新角色。
public Task<RestRole> CreateRoleAsync(string name, RequestOptions? options = null)
Parameters
name
string角色的名称。
options
RequestOptions发送请求时要使用的选项。
Returns
CreateTextChannelAsync(string, Action<CreateTextChannelProperties>?, RequestOptions?)
在此服务器内创建一个新的文字频道。
public Task<RestTextChannel> CreateTextChannelAsync(string name, Action<CreateTextChannelProperties>? func = null, RequestOptions? options = null)
Parameters
name
string频道的名称。
func
Action<CreateTextChannelProperties>一个包含要应用到新创建频道的配置的委托。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<RestTextChannel>
一个表示异步创建操作的任务。任务的结果包含新创建的文字频道。
CreateVoiceChannelAsync(string, Action<CreateVoiceChannelProperties>?, RequestOptions?)
在此服务器内创建一个新的语音频道。
public Task<RestVoiceChannel> CreateVoiceChannelAsync(string name, Action<CreateVoiceChannelProperties>? func = null, RequestOptions? options = null)
Parameters
name
string频道的名称。
func
Action<CreateVoiceChannelProperties>一个包含要应用到新创建频道的配置的委托。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<RestVoiceChannel>
一个表示异步创建操作的任务。任务的结果包含新创建的语音频道。
DeleteEmoteAsync(GuildEmote, RequestOptions?)
删除此服务器内的现有自定义表情。
public Task DeleteEmoteAsync(GuildEmote emote, RequestOptions? options = null)
Parameters
emote
GuildEmote要删除的自定义表情。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步删除操作的任务。
DownloadBoostSubscriptionsAsync(RequestOptions?)
下载此服务器内的所有服务器助力信息。
public Task DownloadBoostSubscriptionsAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步下载操作的任务。
Remarks
此方法会通过网关下载此服务器内的所有服务器助力信息,并缓存它们。 要下载所有服务器助力信息,当前用户必须具有 ManageGuild 权限。
DownloadUsersAsync(RequestOptions?)
下载此服务器内的所有用户。
public Task DownloadUsersAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步下载操作的任务。
Remarks
此方法会下载所有加入到此服务器内的用户,并缓存它们。
DownloadVoiceStatesAsync(RequestOptions?)
下载此服务器内的所有语音状态。
public Task DownloadVoiceStatesAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步下载操作的任务。
Remarks
此方法会下载此服务器内的所有语音状态,并缓存它们。
GetActiveBoostSubscriptionsAsync(RequestOptions?)
获取此服务器所有生效中的服务器助力包。
public Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>> GetActiveBoostSubscriptionsAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>>
一个表示异步获取操作的任务。任务的结果是所有为此服务器助力的用户及所应用的生效中的服务器助力包。
GetBadgeAsync(BadgeStyle, RequestOptions?)
获取与此服务器关联的徽章。
public Task<Stream> GetBadgeAsync(BadgeStyle style = BadgeStyle.GuildName, RequestOptions? options = null)
Parameters
style
BadgeStyle要获取的徽章的样式。
options
RequestOptions发送请求时要使用的选项。
Returns
GetBanAsync(IUser, RequestOptions?)
获取指定用户在此服务器内当前的封禁信息。
public Task<RestBan?> GetBanAsync(IUser user, RequestOptions? options = null)
Parameters
user
IUser要获取封禁信息的用户。
options
RequestOptions发送请求时要使用的选项。
Returns
GetBanAsync(ulong, RequestOptions?)
获取指定用户在此服务器内的封禁信息。
public Task<RestBan?> GetBanAsync(ulong userId, RequestOptions? options = null)
Parameters
userId
ulong要获取封禁信息的用户的 ID。
options
RequestOptions发送请求时要使用的选项。
Returns
GetBansAsync(RequestOptions?)
获取此服务器的所有封禁信息。
public Task<IReadOnlyCollection<RestBan>> GetBansAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<IReadOnlyCollection<RestBan>>
一个表示异步获取操作的任务。任务的结果包含此服务器的所有封禁信息。
GetBoostSubscriptionsAsync(RequestOptions?)
所有此服务器的所有服务器助力包。
public Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>> GetBoostSubscriptionsAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<ImmutableDictionary<IUser, IReadOnlyCollection<BoostSubscriptionMetadata>>>
一个表示异步获取操作的任务。任务的结果是所有为此服务器助力的用户及所应用的服务器助力包。
GetCategoryChannel(ulong)
获取此服务器内指定的分组频道
public SocketCategoryChannel? GetCategoryChannel(ulong id)
Parameters
id
ulong要获取的频道的 ID。
Returns
- SocketCategoryChannel
与指定的
id
关联的频道;如果未找到,则返回null
。
GetChannel(ulong)
获取此服务器内的频道。
public SocketGuildChannel? GetChannel(ulong id)
Parameters
id
ulong要获取的频道的 ID。
Returns
- SocketGuildChannel
与指定的
id
关联的频道;如果未找到,则返回null
。
GetEmote(string)
获取此服务器的指定自定义表情。
public GuildEmote? GetEmote(string id)
Parameters
id
string要获取的自定义表情的 ID。
Returns
- GuildEmote
与指定的
id
关联的自定义表情;如果未找到,则返回null
。
GetEmoteAsync(string, RequestOptions?)
获取此服务器的指定自定义表情。
public Task<GuildEmote?> GetEmoteAsync(string id, RequestOptions? options = null)
Parameters
id
string要获取的自定义表情的 ID。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<GuildEmote>
一个表示异步获取操作的任务。任务的结果包含与指定的
id
关联的自定义表情;如果未找到,则返回null
。
GetEmotesAsync(RequestOptions?)
获取此服务器的所有自定义表情。
public Task<IReadOnlyCollection<GuildEmote>> GetEmotesAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<IReadOnlyCollection<GuildEmote>>
一个表示异步获取操作的任务。任务的结果包含此服务器的所有自定义表情。
GetInvitesAsync(RequestOptions?)
获取此服务器内的所有邀请信息。
public Task<IReadOnlyCollection<IInvite>> GetInvitesAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task<IReadOnlyCollection<IInvite>>
一个表示异步获取操作的任务。任务的结果包含此服务器内的所有邀请信息。
GetRole(uint)
获取此服务器内的角色。
public SocketRole? GetRole(uint id)
Parameters
id
uint要获取的角色的 ID。
Returns
- SocketRole
一个表示异步获取操作的任务。任务的结果包含与指定的
id
关联的角色;如果未找到,则返回null
。
GetTextChannel(ulong)
获取此服务器中所有具有文字聊天能力的频道。
public SocketTextChannel? GetTextChannel(ulong id)
Parameters
id
ulong要获取的频道的 ID。
Returns
- SocketTextChannel
与指定的
id
关联的频道;如果未找到,则返回null
。
Remarks
语音频道也是一种文字频道,此方法本意用于获取具有文字聊天能力的频道。如果通过此方法传入的 ID 对应的频道是语音频道,那么也会返回对应的语音频道实体。 如需获取频道的实际类型,请参考 GetChannelType(IChannel)。
GetUser(ulong)
获取此服务器内的用户。
public SocketGuildUser? GetUser(ulong id)
Parameters
id
ulong要获取的用户的 ID。
Returns
- SocketGuildUser
与指定的
id
关联的用户;如果未找到,则返回null
。
Remarks
此方法可能返回 null
,因为在大型服务器中,用户列表的缓存可能不完整。
GetUsersAsync(RequestOptions?)
获取此服务器内的所有用户。
public IAsyncEnumerable<IReadOnlyCollection<IGuildUser>> GetUsersAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- IAsyncEnumerable<IReadOnlyCollection<IGuildUser>>
一个表示异步获取操作的任务。任务的结果包含此服务器内的所有用户。
GetVoiceChannel(ulong)
获取此服务器内指定具有语音聊天能力的频道。
public SocketVoiceChannel? GetVoiceChannel(ulong id)
Parameters
id
ulong要获取的频道的 ID。
Returns
- SocketVoiceChannel
一个表示异步获取操作的任务。任务的结果包含与指定的
id
关联的频道;如果未找到,则返回null
。
LeaveAsync(RequestOptions?)
退出此服务器。
public Task LeaveAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步退出操作的任务。
ModifyEmoteNameAsync(GuildEmote, string, RequestOptions?)
修改此服务器内的现有自定义表情。
public Task ModifyEmoteNameAsync(GuildEmote emote, string name, RequestOptions? options = null)
Parameters
emote
GuildEmote要修改的自定义表情。
name
string新的自定义表情名称。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步修改操作的任务。任务的结果包含修改后的自定义表情。
MoveUsersAsync(IEnumerable<IGuildUser>, IVoiceChannel, RequestOptions?)
移动用户到语音频道。
public Task MoveUsersAsync(IEnumerable<IGuildUser> users, IVoiceChannel targetChannel, RequestOptions? options = null)
Parameters
users
IEnumerable<IGuildUser>要移动的用户。
targetChannel
IVoiceChannel要移动用户到的语音频道。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步移动操作的任务。
PurgeUserCache()
清除此服务器的用户缓存。
public void PurgeUserCache()
PurgeUserCache(Predicate<SocketGuildUser>)
清除此服务器的用户缓存。
public void PurgeUserCache(Predicate<SocketGuildUser> predicate)
Parameters
predicate
Predicate<SocketGuildUser>要清除的用户的筛选条件。
RemoveBanAsync(IUser, RequestOptions?)
解除服务器对用户的封禁。
public Task RemoveBanAsync(IUser user, RequestOptions? options = null)
Parameters
user
IUser要解除封禁的用户。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步封禁解除操作的任务。
RemoveBanAsync(ulong, RequestOptions?)
解除服务器对用户的封禁。
public Task RemoveBanAsync(ulong userId, RequestOptions? options = null)
Parameters
userId
ulong要解除封禁的用户的 ID。
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步封禁解除操作的任务。
SearchUsersAsync(Action<SearchGuildMemberProperties>, int, RequestOptions?)
搜索加入到此服务器内匹配指定搜索条件的所有用户。
public IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>> SearchUsersAsync(Action<SearchGuildMemberProperties> func, int limit = 50, RequestOptions? options = null)
Parameters
func
Action<SearchGuildMemberProperties>一个包含要搜索的用户属性及排序条件的委托。
limit
int搜索结果的最大数量。
options
RequestOptions发送请求时要使用的选项。
Returns
- IAsyncEnumerable<IReadOnlyCollection<RestGuildUser>>
一个表示异步获取操作的任务。任务的结果包含与提供的
func
中指定的属性匹配的服务器用户集合。
Remarks
此方法使用指定的属性搜索服务器用户。要查看可用的属性,请参考 SearchGuildMemberProperties。
ToString()
获取此服务器的名称。
public override string ToString()
Returns
UpdateAsync(RequestOptions?)
通过 REST API 获取此实体对象的最新状态,并替换当前对象的属性。
public Task UpdateAsync(RequestOptions? options = null)
Parameters
options
RequestOptions发送请求时要使用的选项。
Returns
- Task
一个表示异步更新操作的任务。
Remarks
warning
此方法将从 KOOK REST API 获取最新数据,并替换当前对象的属性,而非使用指定的属性修改 KOOK 服务端的数据。