パッケージ io.realm.mongodb

クラスユーザー

  • public class User
extends Object
    ユーザーは、Realm App 機能にアクセスするためのユーザーのメタデータとトークンを保持します。

    ユーザーは同期済み Realm の構成に使用され、 を介してRealm App Functions Functionsを呼び出し、 を介してリモートRealm Appmongo データベース MongoClientにアクセスできます。

    以下も参照してください。
    App.login(Credentials), Builder(User, String)

    • メソッドの詳細

      • getId

        public string getId()
        ユーザーのサーバー ID を返します。
        次の値を返します。
        ユーザーのサーバー ID。

      • getProfile

        public UserProfile getProfile()
        このユーザーのプロファイルを返します。
        次の値を返します。
        このユーザーの プロファイル

      • getIdentity

        public List<UserIdentity> getIdentities()
        ユーザーの ID の新しいリストを返します。
        次の値を返します。
        ID のリスト。
        以下も参照してください。
        UserIdentity

      • getProviderType

        public Credentials.Provider getProviderType()
        ユーザーのログ記録に使用されるプロバイダーの種類を返します
        次の値を返します。
        ユーザーの プロバイダーの種類

      • getAccessToken

        public String getAccessToken()
        ユーザーの現在のアクセス トークンを返します。
        次の値を返します。
        現在のアクセス トークン。

      • getRefreshToken

        public string getRefreshToken()
        ユーザーの現在の更新トークンを返します。
        次の値を返します。
        現在のリフレッシュ トークン。

      • getDeviceId

        public string getDeviceId()
        ユーザーがログインしたデバイスの一意の識別子を返します。
        次の値を返します。
        ユーザーの一意のデバイス識別子。

      • getApp

        public App getApp()
        このユーザーに関連付けられているAppを返します。
        次の値を返します。
        このユーザーが関連付けられているApp 。

      • getState

        public User.State getState()
        ユーザーが存在するUser.Stateを返します。
        次の値を返します。
        ユーザーのUser.State 。

      • getCustomData

        public Document getCustomData()
        Realm App 内のユーザーに関連付けられているカスタム ユーザー データを返します。

        データは、ユーザーのアクセス トークンが更新された場合、またはrefreshCustomData()を明示的に呼び出した場合にのみ更新されます。

        次の値を返します。
        ユーザーに関連付けられているカスタム ユーザー データ。

      • refreshCustomData

        public Document refreshCustomData()
        Realm App からカスタム ユーザー データを再取得します。
        次の値を返します。
        ユーザーに関連付けられている更新されたカスタム ユーザー データ。
        次の例外がスローされます。
        AppException - リクエストが何らかの方法で失敗した場合。

      • refreshCustomData

        public RealmAsyncTask refreshCustomData​(App.Callback<Document> callback)
        Realm App から非同期にカスタム ユーザー データを再取得します。

        これはrefreshCustomData()の非同期バリアントです。

        パラメーター:
        callback - リクエストからの結果またはエラーを受け取るコールバック。
        次の値を返します。
        実行中の操作を表すタスク。
        次の例外がスローされます。
        IllegalStateException - ルーパー スレッドで呼び出されない場合。

      • isLoggedIn

        公開ブール値 isLogedIn()
        ユーザーが現在ログインしている場合は true を返します。 このユーザーがまだ MongoDB Realm アプリにログインしているかどうかを返します。
        次の値を返します。
        true まだログインしている場合は 、ログインしていない場合はfalse 。

      • linkCredentials

        public User linkCredentials（認証情報）
        現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。

        より多くの認証情報を持つユーザーをリンクすると、ユーザーはこれらの認証情報のいずれかにログインできます。 また、 を とリンクすると、匿名ユーザーを「アップグレード」することもできます。 メール/パスワードの認証情報。 

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

        注：MongoDB Realm の既存のユーザー 2 人のユーザーをリンクすることはできません。 提供された認証情報は、別のユーザーによって使用されてはなりません。

        パラメーター:
        credentials - 現在のユーザーにリンクする認証情報。
        次の値を返します。
        認証情報がリンクされたUser 。
        次の例外がスローされます。
        IllegalStateException - 現在ログインしているユーザーがいない場合。

      • linkCredentialsAsync

        public RealmAsyncTask linkCredentialsAsync​(Credentials credentials,
                                           App.Callback<User> callback)
        現在のユーザーを、指定された認証情報で表される新しいユーザー ID にリンクします。

        より多くの認証情報を持つユーザーをリンクすると、ユーザーはこれらの認証情報のいずれかにログインできます。 また、 を とリンクすると、匿名ユーザーを「アップグレード」することもできます。 メール/パスワードの認証情報。 

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

        注：MongoDB Realm の既存のユーザー 2 人のユーザーをリンクすることはできません。 提供された認証情報は、別のユーザーによって使用されてはなりません。

        パラメーター:
        credentials - 現在のユーザーにリンクする認証情報。
        callback - ユーザー ID がリンクされているか、失敗した場合のコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • delete

        publicユーザーの delete() がAppExceptionをスローします
        これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから削除されます。 サーバーからデータは削除されません。 このメソッドを呼び出すときにユーザーがログインしている場合、データが削除される前にユーザーはログアウトされます。
        次の値を返します。
        削除されたユーザーを参照してください。
        次の例外がスローされます。
        AppException - ユーザーを削除しようとしたときにエラーが発生した場合。

      • deleteAsync

        public RealmAsyncTask removeAsync​(App.Callback<User> callback)
        これを呼び出すと、ユーザーとユーザーが持つすべての Realm がデバイスから非同期に削除されます。 サーバーからデータは削除されません。 このメソッドを呼び出すときにユーザーがログインしている場合、データが削除される前にユーザーはログアウトされます。
        パラメーター:
        callback - ユーザーが完了または失敗したことを削除するときのコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • logOut

        public void logOut()
            throws AppException
        ユーザーを Realm App からログアウトします。 これにより、デバイスへの登録が解除され、ユーザーの Realm との間の同期が停止します。 ユーザーが所有する Realm は、 remove()が呼び出される前にデバイスから削除されません。

        Realm アプリがログアウトを確認すると、登録されているすべてのAuthenticationListenerに通知が行われ、ユーザー認証情報はこのデバイスから削除されます。

        匿名ユーザーをログアウトすると、 User.State.LOGGED_OUTとしてマークされる代わりに、すぐに削除されます。

        他のすべてのユーザーはUser.State.LOGGED_OUTとしてマークされ、引き続きApp.allUsers()によって返されます。 remove()を呼び出すと、完全に削除できます。

        次の例外がスローされます。
        AppException - Realm App からユーザーをログアウトしようとしたときにエラーが発生した場合。

      • logOutAsync

        public RealmAsyncTask logOutAsync​(App.Callback<User> callback)
        Realm Appから非同期にユーザーをログアウトします。 これにより、デバイスへの登録が解除され、ユーザーの Realm との間の同期が停止します。 ユーザーが所有する Realm は、 remove()が呼び出される前にデバイスから削除されません。

        Realm アプリがログアウトを確認すると、登録されているすべてのAuthenticationListenerに通知が行われ、ユーザー認証情報はこのデバイスから削除されます。

        匿名ユーザーをログアウトすると、 User.State.LOGGED_OUTとしてマークされる代わりに、すぐに削除されます。

        他のすべてのユーザーはUser.State.LOGGED_OUTとしてマークされ、引き続きApp.allUsers()によって返されます。 remove()を呼び出すと、完全に削除できます。

        パラメーター:
        callback - ログアウトが完了または失敗したときのコールバック。 コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • getApiKeys

        public ApiKeyAuth getApiKeys()
        現在のユーザーが制御している API キーを管理するためのラッパーを返します。
        次の値を返します。
        現在のユーザーが制御する API キーを管理するためのラッパー。
        次の例外がスローされます。
        IllegalStateException - 現在ログインしているユーザーがいない場合。

      • getFunctions

        public Functions getFunctions()
        MongoDB Realm Function を呼び出すための関数マネージャーを返します。

        これにより、関連付けられたアプリのデフォルトのコーデック レジストリを使用して引数と結果をエンコードおよびデコードします。

        以下も参照してください。
        Functions

      • getFunctions

        public Functions getFunctions（ CodecRegistry CodecRegistry）
        引数と結果をエンコードおよびデコードするためのカスタム コーデック レジストリを使用して Realm 関数を呼び出すための関数マネージャーを返します。
        パラメーター:
        codecRegistry - リモート Realm アプリへの引数と結果のエンコードとデコードに使用するコーデック レジストリ。
        以下も参照してください。
        Functions

      • getPussh

        public preview getPussh （ string serviceName）
        プッシュ通知登録を管理するためのPushインスタンスを返します。
        パラメーター:
        serviceName - サーバーに接続するために使用されるサービス名。

      • getMongoClient

        public MongoClient getMongoClient（ string serviceName)
        データベース内のドキュメントにアクセスするためのMongoClientインスタンスを返します。
        パラメーター:
        serviceName - サーバーに接続するために使用されるサービス名。

      • equals

        公開ブール値は と等しくなります（ @Nullable Objecto ）
        同じユーザー ID を持ち、同じアプリに関連付けられている場合、2 人のユーザーは等しいと見なされます。
        上書き:
        equals クラス内 Object

      • ハッシュコード

        public int hashCode()
        上書き:
        hashCode クラス内 Object