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

クラス関数

java.lang.Object

io.realm.mongodb.functions.Functions

public abstract class Functions
extends Object

関連付けられている Realm アプリのリモート Realm 関数を呼び出すための関数マネージャー。

引数と結果は、 から継承されるか、 を通じてAppConfiguration.getDefaultCodecRegistry() 関数 のインスタンスを作成するときに明示的に設定される 関数のUser.getFunctions(CodecRegistry) callFunction(String, List, Class, CodecRegistry)コーデック レジストリを使用してエンコードまたはデコードされます。

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

User.getFunctions(), User.getFunctions(CodecRegistry), App.getFunctions(User), App.getFunctions(User, CodecRegistry), AppConfiguration, CodecRegistry

メソッドの概要

修飾子と型	方式	説明
<ResultT> ResultT	callFunction(String name, List<?> args, Class<ResultT> resultClass)	デフォルトのコーデック レジストリのエンコード/デコード引数/結果と同期して MongoDB Realm 関数を呼び出します。
<ResultT> ResultT	callFunction(String name, List<?> args, Class<ResultT> resultClass, CodecRegistry codecRegistry)	カスタム コーデック レジストリのエンコード/デコード引数/結果と同期して MongoDB Realm 関数を呼び出します。
<ResultT> ResultT	callFunction(String name, List<?> args, Decoder<ResultT> resultDecoder)	カスタム結果デコードを使用して同期的に MongoDB Realm 関数を呼び出します。
<T> RealmAsyncTask	callFunctionAsync(String name, List<?> args, Class<T> resultClass, App.Callback<T> callback)	引数と結果をエンコードおよびデコードするために、カスタム コーデック レジストリを使用して MongoDB Realm 関数を非同期に呼び出します。
<T> RealmAsyncTask	callFunctionAsync(String name, List<?> args, Class<T> resultClass, CodecRegistry codecRegistry, App.Callback<T> callback)	引数と結果をエンコードおよびデコードするために、カスタム コーデック レジストリを使用して MongoDB Realm 関数を非同期に呼び出します。
<T> RealmAsyncTask	callFunctionAsync(String name, List<?> args, Decoder<T> resultDecoder, App.Callback<T> callback)	カスタム結果デコードを使用して非同期に MongoDB Realm 関数を呼び出します。
App	getApp()	この インスタンスが関連付けられているAppを返します。
CodecRegistry	getDefaultCodecRegistry()	このRealm 関数インスタンスの引数をエンコードし、結果をデコードするために使用されるデフォルトのコーデック レジストリを返します。
User	getUser()	この インスタンスが関連付けられているUserを返します。

クラス java.lang から継承されたメソッド。オブジェクト

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

CallFunction

public <ResultT> ResultT callFunction(String name,
                                      List<?> args,
                                      Class<ResultT> resultClass,
                                      CodecRegistry codecRegistry)

カスタム コーデック レジストリのエンコード/デコード引数/結果と同期して MongoDB Realm 関数を呼び出します。

型パラメータ:

ResultT - codecRegistryを使用して応答がデコードされるタイプ。

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultClass - 関数の結果が変換される型。

codecRegistry - 引数のエンコードと結果のデコードに使用するコーデック レジストリ。

次の値を返します。

Realm 関数の結果。

次の例外がスローされます。

AppException - リクエストが何らかの方法で失敗した場合。

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

callFunctionAsync(String, List, Class, CodecRegistry, App.Callback), AppConfiguration.getDefaultCodecRegistry()

CallFunction

public <ResultT> ResultT callFunction(String name,
                                      List<?> args,
                                      Class<ResultT> resultClass)

デフォルトのコーデック レジストリのエンコード/デコード引数/結果と同期して MongoDB Realm 関数を呼び出します。

型パラメータ:

ResultT - デフォルトのコーデック レジストリを使用して応答がデコードされるタイプ。

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultClass - 関数の結果が変換される型。

次の値を返します。

Realm 関数の結果。

次の例外がスローされます。

AppException - リクエストが何らかの方法で失敗した場合。

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

callFunction(String, List, Class, CodecRegistry), AppConfiguration.getDefaultCodecRegistry()

CallFunction

public <ResultT> ResultT callFunction(String name,
                                      List<?> args,
                                      Decoder<ResultT> resultDecoder)

カスタム結果デコードを使用して同期的に MongoDB Realm 関数を呼び出します。

引数はデフォルトのコーデック レジストリ エンコードでエンコードされます。

型パラメータ:

ResultT - 応答がデコードされるタイプ resultDecoder

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultDecoder - 結果をデコードするために使用されるデコード。

次の値を返します。

Realm 関数の結果。

次の例外がスローされます。

AppException - リクエストが何らかの方法で失敗した場合。

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

callFunction(String, List, Class, CodecRegistry), AppConfiguration.getDefaultCodecRegistry()

CallFunctionAsync

public <T> RealmAsyncTask callFunctionAsync(String name,
                                            List<?> args,
                                            Class<T> resultClass,
                                            CodecRegistry codecRegistry,
                                            App.Callback<T> callback)

引数と結果をエンコードおよびデコードするために、カスタム コーデック レジストリを使用して MongoDB Realm 関数を非同期に呼び出します。

これはcallFunction(String, List, Class, CodecRegistry)の非同期に相当します。

型パラメータ:

T - デフォルトのコーデック レジストリを使用して応答がデコードされるタイプ。

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultClass - 関数の結果が変換される型。

codecRegistry - 引数のエンコードと結果のデコードに使用するコーデック レジストリ。

callback - リクエストからの結果またはエラーを受け取るコールバック。

次の値を返します。

実行中の操作を表すタスク。

次の例外がスローされます。

IllegalStateException - ルーパー スレッドで呼び出されない場合。

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

callFunction(String, List, Class, CodecRegistry), callFunctionAsync(String, List, Class, CodecRegistry, App.Callback), AppConfiguration.getDefaultCodecRegistry()

CallFunctionAsync

public <T> RealmAsyncTask callFunctionAsync(String name,
                                            List<?> args,
                                            Class<T> resultClass,
                                            App.Callback<T> callback)

引数と結果をエンコードおよびデコードするために、カスタム コーデック レジストリを使用して MongoDB Realm 関数を非同期に呼び出します。

これはcallFunction(String, List, Class)の非同期に相当します。

型パラメータ:

T - デフォルトのコーデック レジストリを使用して応答がデコードされるタイプ。

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultClass - 関数の結果が変換される型。

callback - リクエストからの結果またはエラーを受け取るコールバック。

次の値を返します。

実行中の操作を表すタスク。

次の例外がスローされます。

IllegalStateException - ルーパー スレッドで呼び出されない場合。

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

callFunction(String, List, Class), callFunctionAsync(String, List, Class, CodecRegistry, App.Callback), AppConfiguration.getDefaultCodecRegistry()

CallFunctionAsync

public <T> RealmAsyncTask callFunctionAsync(String name,
                                            List<?> args,
                                            Decoder<T> resultDecoder,
                                            App.Callback<T> callback)

カスタム結果デコードを使用して非同期に MongoDB Realm 関数を呼び出します。

これはcallFunction(String, List, Decoder)の非同期に相当します。

型パラメータ:

T - 応答がデコードされるタイプ resultDecoder

パラメーター:

name - 呼び出す Realm 関数の名前。

args - Realm 関数への引数。

resultDecoder - 結果をデコードするために使用されるデコード。

callback - リクエストからの結果またはエラーを受け取るコールバック。

次の値を返します。

実行中の操作を表すタスク。

次の例外がスローされます。

IllegalStateException - ルーパー スレッドで呼び出されない場合。

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

callFunction(String, List, Class), callFunctionAsync(String, List, Class, CodecRegistry, App.Callback), AppConfiguration.getDefaultCodecRegistry()

getDefaultCodecRegistry

public CodecRegistry getDefaultCodecRegistry()

このRealm 関数インスタンスの引数をエンコードし、結果をデコードするために使用されるデフォルトのコーデック レジストリを返します。

次の値を返します。

デフォルトのコーデック レジストリ。

getApp

public App getApp()

この インスタンスが関連付けられているAppを返します。

次の値を返します。

このインスタンスが関連付けられているApp 。

getUser

publicユーザーgetUser()

この インスタンスが関連付けられているUserを返します。

次の値を返します。

このインスタンスが関連付けられているUser 。