安装包 io.realm.mongodb

类凭证

  • public class Credentials
extends Object
    档案代表使用给定提供商的登录，MongoDB Realm 使用档案来验证用户并授予访问权限。默认， Credentials.Provider.EMAIL_PASSWORD提供商处于启用状态。 所有其他提供商必须在 MongoDB Realm 上启用才能运行。

    请注意，想要使用电子邮件/密码登录的用户必须首先使用EmailPasswordAuth.registerUser(String, String)进行注册。

    凭证的使用方式如下： 
     
 // Example
 App app = new App("app-id");
 Credentials credentials = Credentials.emailPassword("email", "password");
 User user = app.loginAsync(credentials, new App.Callback<User>() {
   \@Override
   public void onResult(Result<User> result) {
     if (result.isSuccess() {
       handleLogin(result.get());
     } else {
       handleError(result.getError());
     }
   }
 ));
 }
    另请参阅：
    对提供商进行身份验证

    • 方法详细信息

      • 匿名

        public static Credentials anonymous()
        创建代表匿名用户的档案。

        再次注销用户意味着数据丢失且无法恢复，并且无法跨设备共享用户详细信息。

        匿名用户必须链接到另一个真实用户，才能在注销后保留数据。

        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • apiKey

        public static Credentials apiKey​(String key)
        使用用户 API 密钥创建表示登录的凭证。

        必须在 MongoDB Realm 上启用此提供商才能运行。

        参数：
        key - 用于登录的 API 密钥。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • Apple

        public static Credentials apple​(String idToken)
        使用 Apple ID 令牌创建表示登录的凭证。

        必须在 MongoDB Realm 上启用此提供商才能运行。

        参数：
        idToken - 使用 Apple 登录时生成的 ID 令牌。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • 自定义函数

        public static Credentials customFunction​(Document arguments)
        使用Document创建表示来自 MongoDB Realm 的远程函数的档案，该档案将被解析为远程函数的参数，因此键必须与函数期望的格式和名称匹配。

        必须在 MongoDB Realm 上启用此提供商才能运行。

        参数：
        arguments — 包含函数参数的文档。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • emailPassword

        public static Credentials emailPassword​(String email,
                                        String password)
        使用电子邮件和密码创建表示登录的凭证。
        参数：
        email - 用户登录的电子邮件。
        password - 登录用户的密码。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • Facebook

        public static Credentials facebook​(String accessToken)
        使用 Facebook 访问令牌创建表示登录的档案。

        必须在 MongoDB Realm 上启用此提供商才能运行。

        参数：
        accessToken - 登录 Facebook 时返回的访问令牌。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • jwt

        public static Credentials jwt​(String jwtToken)
        使用 JWT 令牌创建表示登录的档案。 此令牌通常在自定义 OAuth2 登录流程后生成。

        必须在 MongoDB Realm 上启用此提供商才能运行。

        参数：
        jwtToken — 自定义登录其他服务后返回的 JSON web token 令牌。
        返回：
        一组凭证，可用于使用App.loginAsync(Credentials, App.Callback)登录 MongoDB Realm。

      • getIdentityProvider

        public Credentials.Provider getIdentityProvider()
        返回用于进行身份验证的身份提供商。
        返回：
        标识所选凭证的提供商。

      • asJson

        public String asJson()
        返回序列化为 json 字符串的凭证对象。
        返回：
        凭证对象的 JSON 序列化字符串。