User.ApiKeyClient 类

一个公开功能的类，以便用户从客户端托管 API 密钥。它的作用域始终限于特定用户，并且只能通过ApiKeys访问。

继承
对象
User.ApiKeyClient
命名空间： Realm 。 Sync
程序集：Realm.dll
语法
public class User.ApiKeyClient

方法

| 编辑本页 查看源代码

CreateAsync(string)

创建可用于对用户进行身份验证的 API 密钥。

声明
public Task<ApiKey> CreateAsync(string name)
参数
类型 名称 说明
字符串 名称

密钥的友好名称。
返回：
类型 说明
任务< ApiKey >

表示异步操作的可等待任务<TResult> 。成功完成表示已在服务器上创建ApiKey ，且其值可用于创建ApiKey(string) 。
备注

此时必须保留返回的 API 密钥的值，因为这是它唯一可见的时间。 密钥在创建时启用。 可以通过调用DisableAsync(ObjectId)将其禁用。

| 编辑本页 查看源代码

DeleteAsync(ObjectId)

按 ID 删除 API 密钥。

声明
public Task DeleteAsync(ObjectId id)
参数
类型 名称 说明
ObjectId id

要删除的密钥的 ID。
返回：
类型 说明
任务

表示异步删除操作的可等待任务。
| 编辑本页 查看源代码

DisableAsync(ObjectId)

按 ID 禁用 API 密钥。

声明
public Task DisableAsync(ObjectId id)
参数
类型 名称 说明
ObjectId id

要禁用的密钥的 ID。
返回：
类型 说明
任务

表示异步禁用操作的可等待任务。
另请参阅
| 编辑本页 查看源代码

EnableAsync(ObjectId)

按 ID 启用 API 密钥。

声明
public Task EnableAsync(ObjectId id)
参数
类型 名称 说明
ObjectId id

要启用的密钥的 ID。
返回：
类型 说明
任务

表示异步启用操作的可等待任务。
另请参阅
| 编辑本页 查看源代码

FetchAllAsync()

获取与用户关联的所有 API 密钥。

声明
public Task<IEnumerable<ApiKey>> FetchAllAsync()
返回：
类型 说明
任务< IEnumerable < ApiKey >>

表示异步查找操作的可等待任务。 完成后，结果包含该用户的所有 API 密钥的collection。
| 编辑本页 查看源代码

FetchAsync(ObjectId)

按 ID 获取特定用户 API 密钥。

声明
public Task<ApiKey?> FetchAsync(ObjectId id)
参数
类型 名称 说明
ObjectId id

要获取的密钥的 ID。
返回：
类型 说明
任务< ApiKey >

表示异步查找操作的可等待任务<TResult> 。