Docs 菜单
Docs 主页
/ /
Atlas Device SDKs
/ / /

类用户

java.lang.Object
io.realm.mongodb.User

用户 持有用于访问Realm App 功能的用户元数据和令牌。用户用于配置同步 Realm,并提供通过 函数 调用Realm App 功能 和访问远程Realm App 的访问访问权限

mongo通过 MongoClient 访问 数据库

另请参阅:

  • App.login(Credentials)

  • io.realm.mongodb.sync.SyncConfiguration.Builder.Builder(User, String)

修饰符和类型
类和描述

public static final

修饰符和类型
方法和说明

公共布尔值

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

public String

返回用户的当前访问令牌。

public synchronized ApiKeyAuth

返回用于管理当前用户控制的 API 密钥的包装器。

public App

返回与此用户关联的应用

public Document

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

public String

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

public Functions

CodecRegistry codecRegistry
)

返回一个函数管理器,用于使用自定义编解码器注册表调用Realm函数,以对参数和结果进行编码和解码。

public synchronized Functions

返回用于调用 MongoDB Realm 函数的函数管理器。

public String

返回用户的服务器 ID。

public List

返回用户身份的新列表。

public synchronized MongoClient

String serviceName
)

返回用于访问数据库中文档的MongoClient实例。

返回此用户的配置文件。

返回用于登录用户的提供商类型

public synchronized Push

String serviceName
)

返回用于管理推送通知注册的推送实例。

public String

返回用户的当前刷新令牌。

public User.State

返回用户所处的状态

公共整型

公共布尔值

如果用户当前已登录,则返回 true。

公共用户

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

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

public void

将用户从 Realm 应用中注销。

以异步方式将用户从 Realm 应用中注销。

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

public Document

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

公共用户

调用此函数将从设备中删除用户和用户拥有的任何 Realm。

调用此函数将从设备中异步删除用户以及用户拥有的任何 Realm。

  • 从类 java.lang.Object 继承的方法 :getClasshashCodeequalsclonetoStringnotifynotifyAllwaitwaitwaitfinalize

public boolean equals (
)

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

覆盖

equals Object 类中

返回用户的当前访问令牌。

返回:

当前访问令牌。

public synchronized ApiKeyAuth getApiKeys ()

返回用于管理当前用户控制的 API 密钥的包装器。

返回:

用于管理当前用户控制的 API 密钥的包装器。

抛出异常

public App getApp ()

返回与此用户关联的应用

返回:

与该用户关联的应用程序

public Document getCustomData ()

返回与Realm应用中的用户关联的自定义用户数据。仅当刷新用户的访问权限令牌或显式调用 refreshCustomData() 时,才会刷新数据。

返回:

与用户关联的自定义用户数据。

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

返回:

用户的唯一设备标识符。

CodecRegistry codecRegistry
)

返回一个函数管理器,用于使用自定义编解码器注册表调用Realm函数,以对参数和结果进行编码和解码。

参数

  • codecRegistry — 用于对远程 Realm 应用的参数和结果进行编码和解码的编解码器注册表。

另请参阅:

public synchronized Functions getFunctions ()

返回用于调用 MongoDB Realm 函数的函数管理器。这将使用关联应用的默认编解码器注册表对参数和结果进行编码和解码。

另请参阅:

public String getId ()

返回用户的服务器 ID。

返回:

用户的服务器 ID。

返回用户身份的新列表。

返回:

身份列表。

另请参阅:

public synchronized MongoClient getMongoClient (
String serviceName
)

返回用于访问数据库中文档的MongoClient实例。

参数

  • serviceName - 用于连接到服务器的服务名称。

返回此用户的配置文件。

返回:

此用户的个人资料

返回用于登录用户的提供商类型

返回:

用户的提供商类型

public synchronized Push getPush (
String serviceName
)

返回用于管理推送通知注册的推送实例。

参数

  • serviceName - 用于连接到服务器的服务名称。

返回用户的当前刷新令牌。

返回:

当前刷新令牌。

返回用户所处的状态

返回:

用户的状态

public int hashCode ()

覆盖

hashCode Object 类中

public boolean isLoggedIn ()

如果用户当前已登录,则返回 true。 返回此用户是否仍登录 MongoDB Realm 应用程序。

返回:

true 如果仍处于登录状态,则返回false

Credentials credentials
)

将当前用户与给定档案表示的新用户身份关联。将用户与更多档案关联,意味着该用户可以登录这些档案中的任何一个。 它还可以通过将匿名用户与以下内容链接来“升级”: 电子邮件/密码凭证。

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

注意:无法关联 MongoDB Realm 的两个现有用户。 所提供的档案不得被其他用户使用。

参数

  • credentials - 与当前用户关联的凭证。

返回:

凭证链接到的用户。

抛出异常

将当前用户与给定档案表示的新用户身份关联。将用户与更多档案关联,意味着该用户可以登录这些档案中的任何一个。 它还可以通过将匿名用户与以下内容链接来“升级”: 电子邮件/密码凭证。

// Example
App app = new App("app-id")
User user = app.login(Credentials.anonymous());
user.linkCredentials(Credentials.emailPassword("email", "password"));

注意:无法关联 MongoDB Realm 的两个现有用户。 所提供的档案不得被其他用户使用。

参数

  • credentials - 与当前用户关联的凭证。

  • callback - 用户身份关联或失败时的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

public void logOut ()

将用户从Realm应用中注销。这将取消用户在设备上的注册,并停止与用户 Realm 之间的任何双向同步。用户拥有的任何 Realm 都不会先于用户从设备中删除。调用删除()。

一旦 Realm 应用确认注销,所有已注册的AuthenticationListener都会收到通知,并且用户档案将从该设备中删除。

注销匿名用户会立即将其删除,而不是将其标记为User.State.LOGGED_OUT

所有其他用户将被标记为 User.State.LOGGED_OUT,并且仍将由 App.allUsers() 返回。可以通过调用 User 将其完全删除。 删除() 。

抛出异常

  • AppException - 如果在尝试将用户从 Realm 应用中注销时发生错误。

以异步方式将用户从Realm应用中注销。这将取消用户在设备上的注册,并停止与用户 Realm 之间的任何双向同步。用户拥有的任何 Realm 都不会先于用户从设备中删除。调用删除()。

一旦 Realm 应用确认注销,所有已注册的AuthenticationListener都会收到通知,并且用户档案将从该设备中删除。

注销匿名用户会立即将其删除,而不是将其标记为User.State.LOGGED_OUT

所有其他用户将被标记为 User.State.LOGGED_OUT,并且仍将由 App.allUsers() 返回。可以通过调用 User 将其完全删除。 删除() 。

参数

  • callback - 注销完成或失败时的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

以异步方式从Realm应用中重新获取自定义用户数据。这是 refreshCustomData() 的异步变体。

参数

  • callback - 将接收请求结果或任何错误的回调。

返回:

代表正在进行的操作的任务。

抛出异常

public Document refreshCustomData ()

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

返回:

更新后与用户关联的自定义用户数据。

抛出异常

public User remove ()

调用此函数将从设备中删除用户和用户拥有的任何 Realm。 不会从服务器中删除任何数据。 如果调用此方法时用户已登录,则在删除任何数据之前,用户将被注销。

返回:

已删除的用户。

抛出异常

  • AppException - 如果在尝试删除用户时发生错误。

调用此函数将从设备中异步删除用户以及用户拥有的任何 Realm。 不会从服务器中删除任何数据。 如果调用此方法时用户已登录,则在删除任何数据之前,用户将被注销。

参数

  • callback - 删除用户已完成或失败时的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

后退

RealmResultTask

在此页面上