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

类 ApiKeyAuth

在此页面上

  • io.realm.mongodb.auth
  • 方法摘要
  • 继承方法
  • 方法详细信息
  • 调用
  • 创建
  • createAsync
  • 删除
  • deleteAsync
  • 禁用
  • disableAsync
  • enable
  • enableAsync
  • 等于
  • 获取
  • fetchAll
  • fetchAsync
  • getApp
  • getUser
  • hashCode
  • toString

io.realm.mongodb.auth

java.lang.Object
io.realm.mongodb.auth.ApiKeyAuth

此类公开功能，以便用户在其控制下托管 API 密钥。

方法摘要

修饰符和类型
方法和说明
受保护的抽象无效
call (
int functionType,
String arg,
OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback
)
公共ApiKey
create (
String name
)

创建可用于对用户进行身份验证的用户 API 密钥。

createAsync (
String name,
io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback
)

异步创建可用于对用户进行身份验证的用户 API 密钥。

public void
delete (
ObjectId id
)

删除用户创建的特定 API 密钥。

deleteAsync (
ObjectId id,
io.realm.mongodb.App.Callback<java.lang.Void> callback
)

删除用户创建的特定 API 密钥。

public void
disable (
ObjectId id
)

禁用用户创建的特定 API 密钥。

disableAsync (
ObjectId id,
io.realm.mongodb.App.Callback<java.lang.Void> callback
)

禁用用户创建的特定 API 密钥。

public void
enable (
ObjectId id
)

启用用户创建的特定 API 密钥。

enableAsync (
ObjectId id,
io.realm.mongodb.App.Callback<java.lang.Void> callback
)

启用用户创建的特定 API 密钥。

公共布尔值
公共ApiKey
fetch (
ObjectId id
)

获取与用户关联的特定用户 API 密钥。

fetchAll (
io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback
)

获取与用户关联的所有 API 密钥。

公共 列表
fetchAll ()

获取与用户关联的所有 API 密钥。

fetchAsync (
ObjectId id,
io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback
)

获取与用户关联的特定用户 API 密钥。

getApp ()

返回与此实例关联的应用。

公共用户
getUser ()

返回与此实例关联的用户。

公共整型
公共string

继承方法

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

方法详细信息

调用

protected abstract void call (
int functionType,
String arg,
OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback
)

创建

public ApiKey create (
String name
)

创建可用于以用户身份进行身份验证的用户 API 密钥。此时必须保留密钥的值，因为这是它唯一可见的时间。

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

参数

  • name - 密钥名称

返回：

用户的新 API 密钥。

抛出异常

createAsync

异步创建可用于对用户身份进行身份验证的用户API密钥。此时必须保留密钥的值，因为这是其唯一可见的时间。

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

参数

  • name - 密钥名称

  • callback — 密钥创建完成或失败时的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

删除

public void delete (
ObjectId id
)

删除用户创建的特定 API 密钥。

参数

  • id - 要删除的密钥的 ID。

抛出异常

deleteAsync

删除用户创建的特定 API 密钥。

参数

  • id - 要删除的密钥的 ID。

  • callback - 被删除或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

禁用

public void disable (
ObjectId id
)

禁用用户创建的特定 API 密钥。

参数

  • id - 要禁用的密钥的 ID。

抛出异常

disableAsync

禁用用户创建的特定 API 密钥。

参数

  • id - 要禁用的密钥的 ID。

  • callback - 当按键被禁用或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

enable

public void enable (
ObjectId id
)

启用用户创建的特定 API 密钥。

参数

  • id - 要启用的密钥的 ID。

抛出异常

enableAsync

启用用户创建的特定 API 密钥。

参数

  • id - 要启用的密钥的 ID。

  • callback - 启用按键或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

等于

public boolean equals (
Object o
)

覆盖

equals 在 Object 类中

获取

public ApiKey fetch (
ObjectId id
)

获取与用户关联的特定用户 API 密钥。

参数

  • id - 要获取的密钥的 ID。

抛出异常

fetchAll

获取与用户关联的所有 API 密钥。

参数

  • callback - 获取密钥或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

public List fetchAll ()

获取与用户关联的所有 API 密钥。

抛出异常

fetchAsync

获取与用户关联的特定用户 API 密钥。

参数

  • id - 要获取的密钥的 ID。

  • callback - 获取密钥或调用失败时使用的回调。 回调将始终发生在调用此方法的同一线程上。

抛出异常

getApp

public App getApp ()

返回与此实例关联的应用。

返回：

与此实例关联的应用。

getUser

public User getUser ()

返回与此实例关联的用户。

返回：

与此实例关联的用户。

hashCode

public int hashCode ()

覆盖

hashCode 在 Object 类中

toString

public String toString ()

覆盖

toString 在 Object 类中

后退

ApiKey

来年

EmailPasswordAuth