パッケージ io.realm.mongodb.auth

Class ApiKeyAuth

  • public abstract class ApiKeyAuth
extends Object
    このクラスは、ユーザーが管理下で API キーを管理するための機能を公開します。

    • メソッドの詳細

      • getUser

        publicユーザーgetUser()
        この インスタンスが関連付けられているUserを返します。
        次の値を返します。
        このインスタンスが関連付けられているUser 。

      • getApp

        public App getApp()
        この インスタンスが関連付けられているAppを返します。
        次の値を返します。
        このインスタンスが関連付けられているApp 。

      • create

        public ApiKey create（ string名）がAppExceptionをスローする
        ユーザーとして認証するために使用できるユーザー API キーを作成します。

        この時点が表示される唯一の時間であるため、キーの値を永続化する必要があります。

        キーは作成時に有効になっています。 disable(ObjectId)を呼び出すことで無効にすることができます。

        パラメーター:
        name - キーの名前
        次の値を返します。
        ユーザーの新しい API キー。
        次の例外がスローされます。
        AppException - サーバーが API キーの作成に失敗した場合。

      • createAsync

        public RealmAsyncTask createAsync​(String name,
                                  App.Callback<ApiKey> callback)
        ユーザーとして認証するために使用できるユーザー API キーを非同期に作成します。

        この時点が表示される唯一の時間であるため、キーの値を永続化する必要があります。

        キーは作成時に有効になっています。 disable(ObjectId)を呼び出すことで無効にすることができます。

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

      • fetch

        public ApiKey fetch （ ObjectId ID）はAppExceptionをスローします
        ユーザーに関連付けられた特定のユーザー API キーを取得します。
        パラメーター:
        id - 取得するキーの ID。
        次の例外がスローされます。
        AppException - サーバーが API キーの取得に失敗した場合。

      • fetchAsync

        public RealmAsyncTask fetchAsync​(ObjectId id,
                                 App.Callback<ApiKey> callback)
        ユーザーに関連付けられた特定のユーザー API キーを取得します。
        パラメーター:
        id - 取得するキーの ID。
        callback - キーが取得されたとき、または呼び出しが失敗したときに使用されるコールバック。 コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • fetchAll

        public List<ApiKey> fetchAll()
                      throws AppException
        ユーザーに関連付けられているすべての API キーを取得します。
        次の例外がスローされます。
        AppException - サーバーが API キーの取得に失敗した場合。

      • fetchAll

        public RealmAsyncTask fetchAll​(App.Callback<List<ApiKey>> callback)
        ユーザーに関連付けられているすべての API キーを取得します。
        パラメーター:
        callback - キーが取得されたとき、または呼び出しが失敗したときに使用されるコールバック。 コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • 削除

        public void delete​(ObjectId id)
            throws AppException
        ユーザーによって作成された特定の API キーを削除します。
        パラメーター:
        id - 削除するキーの ID。
        次の例外がスローされます。
        AppException - サーバーが API キーの削除に失敗した場合。

      • deleteAsync

        public RealmAsyncTask deleteAsync​(ObjectId id,
                                  App.Callback<Void> callback)
        ユーザーによって作成された特定の API キーを削除します。
        パラメーター:
        id - 削除するキーの ID。
        callback - が削除されたとき、または呼び出しが失敗したときに使用されるコールバック。 コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • 無効にする

        public void disable​(ObjectId id)
             throws AppException
        ユーザーが作成した特定の API キーを無効にします。
        パラメーター:
        id - 無効にするキーの ID。
        次の例外がスローされます。
        AppException - サーバーが API キーを無効にするのに失敗した場合。

      • disableAsync

        public RealmAsyncTask disableAsync​(ObjectId id,
                                   App.Callback<Void> callback)
        ユーザーが作成した特定の API キーを無効にします。
        パラメーター:
        id - 無効にするキーの ID。
        callback - キーが無効になっている場合、または呼び出しが失敗した場合に使用されるコールバック。 コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • 有効にする

        public void enable​(ObjectId id)
            throws AppException
        ユーザーが作成した特定の API キーを有効にします。
        パラメーター:
        id - 有効にするキーの ID。
        次の例外がスローされます。
        AppException - サーバーが API キーを有効にできなかった場合。

      • enableAsync

        public RealmAsyncTask enableAsync​(ObjectId id,
                                  App.Callback<Void> callback)
        ユーザーが作成した特定の API キーを有効にします。
        パラメーター:
        id - 有効にするキーの ID。
        callback - キーが有効になっているか、呼び出しが失敗したときに使用されるコールバック。 コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。
        次の例外がスローされます。
        IllegalStateException - 非 loader スレッドから呼び出された場合。

      • equals

        公開ブール値は と等しくなります（ Objecto ）
        上書き:
        equals クラス内 Object

      • ハッシュコード

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