安装包 io.realm.mongodb.auth

类 ApiKeyAuth

  • public abstract class ApiKeyAuth
extends Object
    此类公开功能，以便用户在其控制下托管 API 密钥。

    • 方法详细信息

      • getUser

        public User getUser()
        返回与此实例关联的User 。
        返回：
        与此实例关联的User 。

      • getApp

        public App getApp()
        返回与此实例关联的App 。
        返回：
        与此实例关联的App 。

      • 创建

        public ApiKey create​( String name) throws AppException
        创建可用于对用户进行身份验证的用户 API 密钥。

        此时，键的值必须持久化，因为这是它唯一可见的时间。

        密钥在创建时启用。 可以通过调用disable(ObjectId)将其禁用。

        参数：
        name - 密钥名称
        返回：
        用户的新 API 密钥。
        抛出异常：
        AppException - 如果服务器无法创建 API 密钥。

      • createAsync

        public RealmAsyncTask createAsync​(String name,
                                  App.Callback<ApiKey> callback)
        异步创建可用于对用户进行身份验证的用户 API 密钥。

        此时，键的值必须持久化，因为这是它唯一可见的时间。

        密钥在创建时启用。 可以通过调用disable(ObjectId)将其禁用。

        参数：
        name - 密钥名称
        callback — 密钥创建完成或失败时的回调。 回调将始终发生在调用此方法的同一线程上。
        抛出异常：
        IllegalStateException - 如果从非循环线程调用。

      • 获取

        公共ApiKey获取（ ObjectId id）抛出AppException
        获取与用户关联的特定用户 API 密钥。
        参数：
        id - 要获取的密钥的 ID。
        抛出异常：
        AppException - 如果服务器无法获取 API 密钥。

      • fetchAsync

        public RealmAsyncTask fetchAsync​(ObjectId id,
                                 App.Callback<ApiKey> callback)
        获取与用户关联的特定用户 API 密钥。
        参数：
        id - 要获取的密钥的 ID。
        callback - 获取密钥或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。
        抛出异常：
        IllegalStateException - 如果从非循环线程调用。

      • fetchAll

        public List<ApiKey> fetchAll()
                      throws AppException
        获取与用户关联的所有 API 密钥。
        抛出异常：
        AppException - 如果服务器无法获取 API 密钥。

      • fetchAll

        public RealmAsyncTask fetchAll​(App.Callback<List<ApiKey>> callback)
        获取与用户关联的所有 API 密钥。
        参数：
        callback - 获取密钥或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。
        抛出异常：
        IllegalStateException - 如果从非循环线程调用。

      • 删除

        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 - 如果从非循环线程调用。

      • 禁用

        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 - 如果从非循环线程调用。

      • enable

        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 - 如果从非循环线程调用。

      • hashCode

        public int hashCode()
        覆盖：
        hashCode 课堂上 Object