Realm Kotlin SDK — Sync/io.realm.kotlin.mongodb/user

user

接口 user

用户持有用于访问 App Services 和 Device Sync 功能的用户元数据和令牌。

可以使用扩展函数User.profileAsBsonDocument和User.customDataAsBsonDocument访问用户配置文件和自定义数据。

用户用于使用SyncConfiguration.Builder配置同步 Realm。

另请参阅

类型

链接已复制到剪贴板
枚举 State : Enum < User.State >

用户的潜在状态。

属性

链接已复制到剪贴板
摘要 val 访问令牌: 字符串

返回用户的当前访问令牌。 如果用户注销，则会返回空的访问令牌。

链接已复制到剪贴板
摘要 val apiKeyAuth: ApiKeyAuth

授予对ApiKeyAuth接口的访问权限，以便用户可以管理其 API 密钥。

链接已复制到剪贴板
摘要 val APP: 应用

与该用户关联的应用。

链接已复制到剪贴板
摘要 val 设备 ID: 字符串

返回用户登录设备的唯一标识符。

链接已复制到剪贴板
摘要 val 功能: 功能

返回用于调用 App Services Functions 的包装器。

链接已复制到剪贴板
摘要 val id: 字符串

用户的服务器 ID。

链接已复制到剪贴板
摘要 val 身份: 名单<UserIdentity>

返回由为此用户启用的身份验证提供者定义的用户身份列表。

链接已复制到剪贴板
摘要 val 已登录: 布尔

返回此用户是否仍登录到 App Services 应用程序。

链接已复制到剪贴板
摘要 val refreshToken: 字符串

返回用户的当前刷新令牌。 如果用户注销，则返回空刷新令牌。

链接已复制到剪贴板
摘要 val 州: User.State

此用户所处的状态。

功能

链接已复制到剪贴板
@ExperimentalRealmSerializerApi
内联 乐趣 <t> user.customData(序列化器： KSerializer < T > = (this as UserImpl).app.configuration.ejson.serializersModule.serializerOrRealmBuiltInSerializer()): t?

返回与 Realm 应用中的用户关联的自定义用户数据，形式为T 。

链接已复制到剪贴板
内联 乐趣 user.customDataAsBsonDocument(): BsonDocument?

返回与 Realm 应用中的用户关联的自定义用户数据作为BsonDocument 。

链接已复制到剪贴板
摘要 暂停 乐趣 删除()

从 Atlas App Services App 中永久删除该用户。

链接已复制到剪贴板
摘要 操作符覆盖 乐趣 等于(other ：有吗？): 布尔

如果两个用户具有相同的用户身份并与同一应用程序关联，则视为相等。

链接已复制到剪贴板
摘要 暂停 乐趣 linkCredentials(credentials : Credentials): user

将当前用户与给定档案表示的新用户身份关联。

链接已复制到剪贴板
摘要 暂停 乐趣 logout()

将用户从 Realm 应用中注销。 这将取消用户在设备上的注册，并停止与用户 Realm 之间的任何双向同步。 在调用User.remove之前，不会从设备中删除用户拥有的任何 Realm。

链接已复制到剪贴板
@实验KBsonSerializerApi
摘要 乐趣 MongoClient(serviceName : string , EJSON : EJSON ? = null): MongoClient

获取MongoClient ，用于从 App Service 的Data Source访问文档。

链接已复制到剪贴板
@ExperimentalRealmSerializerApi
内联 乐趣 <t> user.profile(序列化器： KSerializer < T > = (this as UserImpl).app.configuration.ejson.serializersModule.serializerOrRealmBuiltInSerializer()): t

以T形式返回此用户的配置文件。

链接已复制到剪贴板
内联 乐趣 user.profileAsBsonDocument(): BsonDocument

返回此用户的配置文件作为BsonDocument 。

链接已复制到剪贴板
摘要 暂停 乐趣 refreshCustomData()

从 Realm 应用重新获取自定义用户数据。

链接已复制到剪贴板
摘要 暂停 乐趣 删除(): user

从设备中删除用户和用户拥有的任何 Realm。 不会从服务器中删除任何数据。