Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas Device SDKs
/
Java SDK
/
API 参考
/
io.realm.mongodb

类凭证

在此页面上

io.realm.mongodb

java.lang.Object
io.realm.mongodb.Credentials

档案代表使用给定登录提供程序的登录，MongoDB Realm 使用档案来验证用户并授予访问权限。 默认启用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 final

Credentials.Provider

方法摘要

修饰符和类型
方法和说明

公共静态凭证

anonymous ()

创建代表匿名用户的档案。

公共静态凭证

apiKey (
String key
)

使用用户 API 密钥创建表示登录的凭证。

公共静态凭证

apple (
String idToken
)

使用 Apple ID 令牌创建表示登录的凭证。

public 字符串

asJson ()

返回序列化为 json 字符串的凭证对象。

公共静态凭证

customFunction (
Document arguments
)

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

公共静态凭证

emailPassword (
String email,
String password
)

使用电子邮件和密码创建表示登录的凭证。

公共静态凭证

facebook (
String accessToken
)

使用 Facebook 访问令牌创建表示登录的档案。

public Credentials.Provider

getIdentityProvider ()

返回用于进行身份验证的身份提供商。

公共静态凭证

google (
String authorizationCode
)

使用GoogleAuthType.AUTH_Code Google 访问令牌创建表示登录的凭证。

公共静态凭证

google (
String token,
GoogleAuthType type
)

使用给定的GoogleAuthType的 Google访问权限令牌创建表示登录的凭证。

公共静态凭证

jwt (
String jwtToken
)

使用 JSON web token 令牌创建表示登录的凭证。

继承方法

  • 从类 java.lang.Object 继承的方法 ：getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

方法详细信息

匿名

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 。

asJson

public String asJson ()

返回序列化为 json 字符串的凭证对象。

返回：

凭证对象的 JSON 序列化字符串。

自定义函数

public static Credentials customFunction (
Document arguments
)

使用文档创建表示来自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 。

getIdentityProvider

返回用于进行身份验证的身份提供商。

返回：

标识所选凭证的提供商。

Google

public static Credentials google (
String authorizationCode
)

使用GoogleAuthType.AUTH_Code Google 访问令牌创建表示登录的凭证。

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

参数

  • authorizationCode — 登录 Google 时返回的授权代码。

返回：

一设立凭证，可用于使用App.loginAsync(Credentials, App.Callback)日志MongoDB Realm 。

public static Credentials google (
String token,
GoogleAuthType type
)

使用给定的GoogleAuthType的 Google访问权限令牌创建表示登录的凭证。

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

参数

  • token — 登录 Google 时返回的访问权限令牌。

  • type —访问权限令牌类型

返回：

一设立凭证，可用于使用App.loginAsync(Credentials, App.Callback)日志MongoDB Realm 。

jwt

public static Credentials jwt (
String jwtToken
)

使用JSON web token创建表示登录的凭证。 此令牌通常在自定义 OAuth 2登录流程后生成。必须在MongoDB Realm上启用此提供商才能运行。

参数

  • jwtToken — 自定义登录其他服务后返回的JSON web token 。

返回：

一设立凭证，可用于使用App.loginAsync(Credentials, App.Callback)日志MongoDB Realm 。

后退

AuthenticationListener

来年

Credentials.Provider