パッケージ 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 にログインするために使用できる認証情報のセット。

      • google

        public static Credentials google​(String token,
                                 GoogleAuthType type)
        指定されたGoogleAuthTypeの Google アクセス トークンを使用して、ログインを表す認証情報を作成します。

        このプロバイダーは、MongoDB Realm で有効にする必要があります。

        パラメーター:
        token - Google にログインするときに返されたアクセス トークン。
        type - アクセス トークンの種類
        次の値を返します。
        App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

      • google

        @Deprecated
public static Credentials google​(String authorizationCode)
        非推奨。
        代わりにgoogle(String, GoogleAuthType)を使用してください。
        GoogleAuthType.AUTH_CODE Googleアクセス トークンを使用して、ログインを表す認証情報を作成します。

        このプロバイダーは、MongoDB Realm で有効にする必要があります。

        パラメーター:
        authorizationCode - Google にログインするときに返された認証コード。
        次の値を返します。
        App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

      • JSON web token

        public static Credentials jwt​(String jwtToken)
        JSON web tokenトークンを使用してログインを表す認証情報を作成します。 このトークンは通常、カスタム OAuth2 ログイン フローの後に生成されます。

        このプロバイダーは、MongoDB Realm で有効にする必要があります。

        パラメーター:
        jwtToken - 別のサービスへのカスタムログイン後に返されるJSON web tokenトークン。
        次の値を返します。
        App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

      • getIdentityProvider

        public Credentials.Provider getIdentityProvider()
        認証に使用される ID プロバイダーを返します。
        次の値を返します。
        選択された認証情報を識別するプロバイダー。

      • asJson

        public string asJson()
        シリアル化された認証情報オブジェクトをJSON stringとして返します。
        次の値を返します。
        認証情報オブジェクトのJSONシリアル化されたstring 。