ApiKey 类

表示User的 API 密钥的类。 它可用于在登录时代表用户，而不是其常规凭证。 这些密钥是通过ApiKeys创建或获取的。
API 密钥的值仅在创建密钥时可用，创建后无法获取。 这意味着调用者有责任在创建 API 密钥时安全地存储该密钥的值。

继承

对象

ApiKey

命名空间： Realm 。 Sync

程序集：Realm.dll

语法

public class ApiKey

属性

id

获取此密钥的唯一标识符。

声明

[Preserve]
public ObjectId Id { get; }

属性值

类型	说明
ObjectId	唯一标识密钥的 ID。

IsEnabled

获取一个值，该值指示此密钥当前是否已启用。

声明

[Preserve]
public bool IsEnabled { get; }

属性值

类型	说明
bool	true 如果该密钥已启用；否则false 。

名称

获取密钥的名称。

声明

[Preserve]
public string Name { get; }

属性值

类型	说明
字符串	调用CreateAsync(string)时指定的键的友好名称。

值

获取键的值。 仅在创建密钥时返回。 之后，它将始终为null 。

声明

[Preserve]
public string? Value { get; }

属性值

类型	说明
字符串	构造ApiKey(string)时需要提供的键的值。

方法

ToString()

返回值的字符串表示形式。

声明

public override string ToString()

返回：

类型	说明
字符串	值的字符串表示形式。

覆盖

object.ToString()

另请参阅

API 密钥身份验证文档