Docs 主页

/ /

io.realm.mongodb.functions

Docs 主页

/ /

API 参考

io.realm.mongodb.functions

io.realm.mongodb.functions

类函数

Atlas Device SDK 已弃用。有关详细信息，请参阅弃用页面。

io.realm.mongodb.functions

java.lang.Object

io.realm.mongodb.functions.Functions

函数管理器，用于为关联的 Realm App 调用远程 Realm 函数。参数和结果使用函数的编解码器注册表进行编码/解码，该注册表可以从AppConfiguration.getDefaultCodecRegistry()继承，也可以在创建

通过User.getFunctions (CodecRegistry)或通过对callFunction( string , List, Class, CodecRegistry)的单独调用来获取函数实例。

提示

方法摘要

修饰符和类型	方法和说明
公共ResultT	callFunction <ResultT >( String name, java.util.List<?> args, <any> resultDecoder ) 使用自定义结果解码器同步调用 MongoDB Realm 函数。
公共ResultT	callFunction <ResultT >( String name, java.util.List<?> args, java.lang.Class<ResultT> resultClass ) 使用默认编解码器注册表编码/解码参数/结果同步调用 MongoDB Realm 函数。
公共ResultT	callFunction <ResultT >( String name, java.util.List<?> args, java.lang.Class<ResultT> resultClass, CodecRegistry codecRegistry ) 使用自定义编解码器注册表编码/解码参数/结果同步调用 MongoDB Realm 函数。
公共RealmAsyncTask	callFunctionAsync <T >( String name, java.util.List<?> args, <any> resultDecoder, io.realm.mongodb.App.Callback<T> callback ) 使用自定义结果解码器异步调用 MongoDB Realm 函数。
公共RealmAsyncTask	callFunctionAsync <T >( String name, java.util.List<?> args, java.lang.Class<T> resultClass, io.realm.mongodb.App.Callback<T> callback ) 使用自定义编解码器注册表异步调用 MongoDB Realm 函数，以对参数/结果进行编码/解码。
公共RealmAsyncTask	callFunctionAsync <T >( String name, java.util.List<?> args, java.lang.Class<T> resultClass, CodecRegistry codecRegistry, io.realm.mongodb.App.Callback<T> callback ) 使用自定义编解码器注册表异步调用 MongoDB Realm 函数，以对参数/结果进行编码/解码。
public App	getApp () 返回与此实例关联的应用。
公共CodecRegistry	getDefaultCodecRegistry () 返回用于此Realm 函数实例的参数编码和结果解码的默认编解码器注册表。
公共用户	getUser () 返回与此实例关联的用户。
受保护的抽象T	invoke <T >( String name, java.util.List<?> args, CodecRegistry codecRegistry, <any> resultDecoder )

继承方法

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

方法详细信息

callFunction

public ResultT callFunction <ResultT >(

String  name,
java.util.List<?>  args,
<any> resultDecoder

)

使用自定义结果解码器同步调用 MongoDB Realm 函数。参数将使用默认编解码器注册表编码进行编码。

类型参数

ResultT - 响应将解码为使用 resultDecoder

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultDecoder - 用于解码结果的解码器。

返回：

Realm 函数的结果。

抛出异常

AppException - 如果请求因某种原因失败。

提示

public ResultT callFunction <ResultT >(

String  name,
java.util.List<?>  args,
java.lang.Class<ResultT>  resultClass

)

使用默认编解码器注册表编码/解码参数/结果同步调用 MongoDB Realm 函数。

类型参数

ResultT - 使用默认编解码器注册表对响应进行解码的类型。

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultClass - 函数结果应转换为的类型。

返回：

Realm 函数的结果。

抛出异常

AppException - 如果请求因某种原因失败。

提示

public ResultT callFunction <ResultT >(

String  name,
java.util.List<?>  args,
java.lang.Class<ResultT>  resultClass,
CodecRegistry codecRegistry

)

使用自定义编解码器注册表编码/解码参数/结果同步调用 MongoDB Realm 函数。

类型参数

ResultT — 使用codecRegistry来解码响应的类型。

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultClass - 函数结果应转换为的类型。
codecRegistry — 用于参数编码和结果解码的编解码器注册表。

返回：

Realm 函数的结果。

抛出异常

AppException - 如果请求因某种原因失败。

提示

callFunctionAsync

public RealmAsyncTask callFunctionAsync <T >(

String  name,
java.util.List<?>  args,
<any> resultDecoder,
io.realm.mongodb.App.Callback<T>  callback

)

使用自定义结果解码器异步调用MongoDB Realm函数。这是callFunction( string , List, Decoder)的异步等效项。

类型参数

T - 响应将解码为使用 resultDecoder

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultDecoder - 用于解码结果的解码器。
callback - 将接收请求结果或任何错误的回调。

返回：

代表正在进行的操作的任务。

抛出异常

IllegalStateException - 如果不是在活套线程上调用。

提示

public RealmAsyncTask callFunctionAsync <T >(

String  name,
java.util.List<?>  args,
java.lang.Class<T>  resultClass,
io.realm.mongodb.App.Callback<T>  callback

)

使用自定义编解码器注册表异步调用MongoDB Realm函数，以对参数/结果进行编码/解码。这是 callFunction(string, List, Class) 的异步等效项。

类型参数

T - 使用默认编解码器注册表对响应进行解码的类型。

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultClass - 函数结果应转换为的类型。
callback - 将接收请求结果或任何错误的回调。

返回：

代表正在进行的操作的任务。

抛出异常

IllegalStateException - 如果不是在活套线程上调用。

提示

public RealmAsyncTask callFunctionAsync <T >(

String  name,
java.util.List<?>  args,
java.lang.Class<T>  resultClass,
CodecRegistry codecRegistry,
io.realm.mongodb.App.Callback<T>  callback

)

使用自定义编解码器注册表异步调用MongoDB Realm函数，以对参数/结果进行编码/解码。这是 callFunction(string, List, Class, CodecRegistry) 的异步等效项。

类型参数

T - 使用默认编解码器注册表对响应进行解码的类型。

参数

name — 要调用的 Realm 函数的名称。
args — Realm 函数的参数。
resultClass - 函数结果应转换为的类型。
codecRegistry — 用于参数编码和结果解码的编解码器注册表。
callback - 将接收请求结果或任何错误的回调。

返回：

代表正在进行的操作的任务。

抛出异常

IllegalStateException - 如果不是在活套线程上调用。

提示

getApp

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

getDefaultCodecRegistry

public CodecRegistry getDefaultCodecRegistry ()
返回用于此Realm 函数实例的参数编码和结果解码的默认编解码器注册表。返回：默认编解码器注册表。

getUser

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

调用

protected abstract T invoke <T >( String name, java.util.List<?> args, CodecRegistry codecRegistry, <any> resultDecoder )

后退

io.realm.mongodb.functions

来年

io.realm.mongodb.log.obfuscator