Docs 主页 → 开发应用程序 → Atlas Device SDKs
类用户
在此页面上
io.realm.mongodb
用户 持有用于访问 Realm App 功能的用户元数据和令牌。用户用于配置同步 Realm,并提供通过 函数调用 Realm App 功能 和 访问远程 Realm App 的访问权限
提示
另请参阅:
io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(User, String)
嵌套类摘要
修饰符和类型 | 类和描述 |
---|---|
public static final |
方法摘要
修饰符和类型 | 方法和说明 |
---|---|
公共布尔值 | |
返回用户的当前访问令牌。 | |
公共同步ApiKeyAuth | getApiKeys () 返回用于管理当前用户控制的 API 密钥的包装器。 |
公共应用程序 | |
公共文档 | 返回与 Realm 应用中的用户关联的自定义用户数据。 |
getDeviceId () 返回用户登录设备的唯一标识符。 | |
公共函数 | 返回一个函数管理器,用于使用自定义编解码器注册表调用 Realm 函数,以对参数和结果进行编码和解码。 |
公共同步函数 | getFunctions () 返回用于调用 MongoDB Realm 函数的函数管理器。 |
getId () 返回用户的服务器 ID。 | |
公共 列表 | 返回用户身份的新列表。 |
公共同步MongoClient | 返回用于访问数据库中文档的MongoClient实例。 |
公共用户配置文件 | getProfile () 返回此用户的配置文件。 |
返回用于登录用户的提供商类型 | |
公共同步推送 | |
返回用户的当前刷新令牌。 | |
公共整型 | hashCode () |
公共布尔值 | isLoggedIn () 如果用户当前已登录,则返回 true。 |
公共用户 | 将当前用户与给定档案表示的新用户身份关联。 |
将当前用户与给定档案表示的新用户身份关联。 | |
公共无效 | logOut () 将用户从 Realm 应用中注销。 |
以异步方式将用户从 Realm 应用中注销。 | |
从 Realm 应用中异步重新获取自定义用户数据。 | |
公共文档 | 从 Realm 应用重新获取自定义用户数据。 |
公共用户 | remove () 调用此函数将从设备中删除用户和用户拥有的任何 Realm。 |
调用此函数将从设备中异步删除用户以及用户拥有的任何 Realm。 |
继承方法
从类 java.lang.Object 继承的方法 :
getClass
、hashCode
、equals
、clone
、toString
、notify
、notifyAll
、wait
、wait
、wait
、finalize
方法详细信息
等于
getAccessToken
公共 字符串 getAccessToken () |
---|
返回用户的当前访问令牌。 返回: 当前访问令牌。 |
getApiKeys
公共同步ApiKeyAuth getApiKeys () |
---|
返回用于管理当前用户控制的 API 密钥的包装器。 返回: 用于管理当前用户控制的 API 密钥的包装器。 抛出异常
|
getApp
getCustomData
public Document getCustomData () |
---|
返回与 Realm 应用中的用户关联的自定义用户数据。仅当刷新用户的访问令牌或显式调用refreshCustomData()时,才会刷新数据。 返回: 与用户关联的自定义用户数据。 |
getDeviceId
getFunctions
返回一个函数管理器,用于使用自定义编解码器注册表调用 Realm 函数,以对参数和结果进行编码和解码。 参数
提示另请参阅: |
公共同步函数getFunctions () |
---|
返回用于调用 MongoDB Realm Functions 的经理。这将使用关联应用的默认编解码器注册表对参数和结果进行编码和解码。 提示另请参阅: |
getId
getIdentities
公共 列表 getIdentities () |
---|
返回用户身份的新列表。 返回: 身份列表。 提示另请参阅: |
getMongoClient
返回用于访问数据库中文档的MongoClient实例。 参数
|
getProfile
public UserProfile getProfile () |
---|
返回此用户的配置文件。 返回: 此用户的个人资料 |
getProviderType
public Credentials.Provider getProviderType () |
---|
返回用于登录用户的提供商类型 返回: 用户的提供商类型 |
getPush
getRefreshToken
公共 字符串 getRefreshToken () |
---|
返回用户的当前刷新令牌。 返回: 当前刷新令牌。 |
getState
public User.State getState () |
---|
hashCode
isLoggedIn
公共布尔isLoggedIn () |
---|
如果用户当前已登录,则返回 true。 返回此用户是否仍登录 MongoDB Realm 应用程序。 返回:
|
linkCredentials
将当前用户与给定档案表示的新用户身份关联。将用户与更多档案关联,平均值该用户可以登录这些档案中的任何一个。它还可以通过将匿名用户与电子邮件/密码凭证等链接来升级匿名用户。
注意:无法关联 MongoDB Realm 的两个现有用户。 所提供的档案不得被其他用户使用。 参数
返回: 凭证链接到的用户。 抛出异常
|
linkCredentialsAsync
将当前用户与给定档案表示的新用户身份关联。将用户与更多档案关联,平均值该用户可以登录这些档案中的任何一个。它还可以通过将匿名用户与电子邮件/密码凭证等链接来升级匿名用户。
注意:无法关联 MongoDB Realm 的两个现有用户。 所提供的档案不得被其他用户使用。 参数
抛出异常
|
logout
public void logOut () |
---|
将用户从 Realm 应用中注销。这将取消用户在设备上的注册,并停止与用户 Realm 之间的任何双向同步。在调用 User.remove()之前,不会从设备中删除用户拥有的任何 Realm。 一旦 Realm 应用确认注销,所有已注册的AuthenticationListener都会收到通知,并且用户档案将从该设备中删除。 注销匿名用户会立即将其删除,而不是将其标记为User.State.LOGGED_OUT 。 所有其他用户将被标记为User.State.LOGGED_OUT ,并且仍将由App.allUsers()返回。可以通过调用User.remove()将其完全删除。 抛出异常
|
logOutAsync
以异步方式将用户从 Realm 应用中注销。这将取消用户在设备上的注册,并停止与用户 Realm 之间的任何双向同步。在调用 User.remove()之前,不会从设备中删除用户拥有的任何 Realm。 一旦 Realm 应用确认注销,所有已注册的AuthenticationListener都会收到通知,并且用户档案将从该设备中删除。 注销匿名用户会立即将其删除,而不是将其标记为User.State.LOGGED_OUT 。 所有其他用户将被标记为User.State.LOGGED_OUT ,并且仍将由App.allUsers()返回。可以通过调用User.remove()将其完全删除。 参数
抛出异常
|
refreshCustomData
以异步方式从 Realm 应用中重新获取自定义用户数据。这是refreshCustomData()的异步变体。 参数
返回: 代表正在进行的操作的任务。 抛出异常
|
public Document refreshCustomData () |
---|
从 Realm 应用重新获取自定义用户数据。 返回: 更新后与用户关联的自定义用户数据。 抛出异常
|
删除
调用此函数将从设备中删除用户和用户拥有的任何 Realm。 不会从服务器中删除任何数据。 如果调用此方法时用户已登录,则在删除任何数据之前,用户将被注销。 返回: 已删除的用户。 抛出异常
|
removeAsync
调用此函数将从设备中异步删除用户以及用户拥有的任何 Realm。 不会从服务器中删除任何数据。 如果调用此方法时用户已登录,则在删除任何数据之前,用户将被注销。 参数
抛出异常
|