Docs Home

/ /

io.realm.mongodb.auth

Docs Home

/ /

API リファレンス

io.realm.mongodb.auth

io.realm.mongodb.auth

Class ApiKeyAuth

Atlas Device SDK は非推奨です。詳細については、の廃止ページを参照してください。

io.realm.mongodb.auth

java.lang.Object

io.realm.mongodb.auth.ApiKeyAuth

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

メソッドの概要

修飾子と型	メソッドと説明
保護された抽象的な無効	call ( int functionType, String arg, OsJavaNetworkTransport.NetworkTransportJNIResultCallback callback )
public ApiKey	create ( String name ) ユーザーとして認証するために使用できるユーザー API キーを作成します。
public RealmAsyncTask	createAsync ( String name, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) ユーザーとして認証するために使用できるユーザー API キーを非同期に作成します。
public void	delete ( ObjectId id ) ユーザーによって作成された特定の API キーを削除します。
public RealmAsyncTask	deleteAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) ユーザーによって作成された特定の API キーを削除します。
public void	disable ( ObjectId id ) ユーザーが作成した特定の API キーを無効にします。
public RealmAsyncTask	disableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) ユーザーが作成した特定の API キーを無効にします。
public void	enable ( ObjectId id ) ユーザーが作成した特定の API キーを有効にします。
public RealmAsyncTask	enableAsync ( ObjectId id, io.realm.mongodb.App.Callback<java.lang.Void> callback ) ユーザーが作成した特定の API キーを有効にします。
パブリックブール値	equals ( Object o )
public ApiKey	fetch ( ObjectId id ) ユーザーに関連付けられた特定のユーザー API キーを取得します。
public RealmAsyncTask	fetchAll ( io.realm.mongodb.App.Callback<java.util.List<io.realm.mongodb.auth.ApiKey>> callback ) ユーザーに関連付けられているすべての API キーを取得します。
public list	fetchAll () ユーザーに関連付けられているすべての API キーを取得します。
public RealmAsyncTask	fetchAsync ( ObjectId id, io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback ) ユーザーに関連付けられた特定のユーザー API キーを取得します。
public App	getApp () このインスタンスが関連付けられているアプリを返します。
publicユーザー	getUser () このインスタンスが関連付けられているユーザーを返します。
public int	hashCode ()
public string	toString ()

継承されたメソッド

クラス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 )

create

public ApiKey create (

String name

)

ユーザーとして認証するために使用できるユーザー API キーを作成します。キーの値は、この時点でのみ表示されるため、この時点で永続化する必要があります。

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

パラメーター

name - キーの名前

戻り値

ユーザーの新しい API キー。

スロー

AppException - サーバーが API キーの作成に失敗した場合。

createAsync

public RealmAsyncTask createAsync (

String name,

io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback

)

は、ユーザーとして認証するために使用できるユーザー API キーを非同期に作成します。キーの値は、この時点でのみ表示されるため、この時点で永続化する必要があります。

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

パラメーター

name - キーの名前
callback - キーの作成が完了または失敗したときのコールバック。コールバックは、このメソッドが呼び出されるのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

削除

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

deleteAsync

public RealmAsyncTask deleteAsync (

ObjectId id,

io.realm.mongodb.App.Callback<java.lang.Void> callback

)

ユーザーによって作成された特定の API キーを削除します。

パラメーター

id - 削除するキーの ID。
callback - が削除されたとき、または呼び出しが失敗したときに使用されるコールバック。コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

無効にする

public void disable ( ObjectId id )
ユーザーが作成した特定の API キーを無効にします。パラメーター `id` - 無効にするキーの ID。スロー AppException - サーバーが API キーを無効にできなかった場合。

disableAsync

public RealmAsyncTask disableAsync (

ObjectId id,

io.realm.mongodb.App.Callback<java.lang.Void> callback

)

ユーザーが作成した特定の API キーを無効にします。

パラメーター

id - 無効にするキーの ID。
callback - キーが無効になっている場合、または呼び出しが失敗した場合に使用されるコールバック。コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

有効にする

public void enable ( ObjectId id )
ユーザーが作成した特定の API キーを有効にします。パラメーター `id` - 有効にするキーの ID。スロー AppException - サーバーが API キーの有効化に失敗した場合。

enableAsync

public RealmAsyncTask enableAsync (

ObjectId id,

io.realm.mongodb.App.Callback<java.lang.Void> callback

)

ユーザーが作成した特定の API キーを有効にします。

パラメーター

id - 有効にするキーの ID。
callback - キーが有効になっているか、呼び出しが失敗したときに使用されるコールバック。コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

equals

public boolean equals ( Object o )
の上書き `equals` クラスオブジェクト内

fetch

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

fetchAll

public RealmAsyncTask fetchAll (

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

)

ユーザーに関連付けられているすべての API キーを取得します。

パラメーター

callback - キーが取得されたとき、または呼び出しが失敗したときに使用されるコールバック。コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

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

fetchAsync

public RealmAsyncTask fetchAsync (

ObjectId id,

io.realm.mongodb.App.Callback<io.realm.mongodb.auth.ApiKey> callback

)

ユーザーに関連付けられた特定のユーザー API キーを取得します。

パラメーター

id - 取得するキーの ID。
callback - キーが取得されたとき、または呼び出しが失敗したときに使用されるコールバック。コールバックは、このメソッドが呼び出されたのと同じスレッドで常に実行されます。

スロー

IllealStateException - 非ルーパースレッドから呼び出された場合。

getApp

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

getUser

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

ハッシュコード

public int hashCode ()
の上書き `hashCode` クラスオブジェクト内

toString

public String toString ()
の上書き `toString` クラスオブジェクト内

戻る

apiKey

EmailPasswordAuth