Package com.mongodb.stitch.android.core.services

Interface StitchServiceClient

All Known Implementing Classes:

StitchServiceClientImpl

public interface StitchServiceClient

StitchServiceClient acts as a general purpose client for working with services that either not defined or well defined by this SDK. It functions similarly to StitchAppClient.callFunction(java.lang.String, java.util.List<?>).

Method Summary

Modifier and Type	Method	Description
Task<Void>	callFunction(String name, List<?> args)	Calls the specified Stitch service function.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Class<ResultT> resultClass)	Calls the specified Stitch service function, and decodes the response into an instance of the specified type.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Class<ResultT> resultClass, CodecRegistry codecRegistry)	Calls the specified Stitch service function, and decodes the response into an instance of the specified type.
Task<Void>	callFunction(String name, List<?> args, Long requestTimeout)	Calls the specified Stitch service function.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Long requestTimeout, Class<ResultT> resultClass)	Calls the specified Stitch service function, and decodes the response into an instance of the specified type.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Long requestTimeout, Class<ResultT> resultClass, CodecRegistry codecRegistry)	Calls the specified Stitch service function, and decodes the response into an instance of the specified type.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Long requestTimeout, Decoder<ResultT> resultDecoder)	Calls the specified Stitch service function, and decodes the response into a value using the provided Decoder.
<ResultT> Task<ResultT>	callFunction(String name, List<?> args, Decoder<ResultT> resultDecoder)	Calls the specified Stitch service function, and decodes the response into a value using the provided Decoder.
CodecRegistry	getCodecRegistry()	Get the codec registry that will be used to decode responses when a codec registry.
StitchServiceClient	withCodecRegistry(CodecRegistry codecRegistry)	Create a new StitchServiceClient instance with a different codec registry.

Method Detail

callFunction

Task<Void> callFunction(String name,
                        List<?> args)

Calls the specified Stitch service function.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

Returns:

a Task that completes when the request completes.

callFunction

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

Calls the specified Stitch service function, and decodes the response into a value using the provided Decoder.

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

resultDecoder - the Decoder to use to decode the response into a value.

Returns:

a Task containing the decoded value.

callFunction

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

Calls the specified Stitch service function, and decodes the response into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

resultClass - the class that the response should be decoded as.

Returns:

a Task containing the decoded value.

callFunction

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

Calls the specified Stitch service function, and decodes the response into an instance of the specified type. The response will be decoded using the codec registry given.

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

resultClass - the class that the response should be decoded as.

codecRegistry - the codec registry used for de/serialization of the function call.

Returns:

a Task containing the decoded value.

callFunction

Task<Void> callFunction(String name,
                        List<?> args,
                        Long requestTimeout)

Calls the specified Stitch service function. Also accepts a timeout in milliseconds. Use this for functions that may run longer than the client-wide default timeout (15 seconds by default).

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

Returns:

a Task that completes when the request completes.

callFunction

<ResultT> Task<ResultT> callFunction(String name,
                                     List<?> args,
                                     Long requestTimeout,
                                     Decoder<ResultT> resultDecoder)

Calls the specified Stitch service function, and decodes the response into a value using the provided Decoder. Also accepts a timeout in milliseconds. Use this for functions that may run longer than the client-wide default timeout (15 seconds by default).

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultDecoder - the Decoder to use to decode the response into a value.

Returns:

a Task containing the decoded value.

callFunction

<ResultT> Task<ResultT> callFunction(String name,
                                     List<?> args,
                                     Long requestTimeout,
                                     Class<ResultT> resultClass)

Calls the specified Stitch service function, and decodes the response into an instance of the specified type. The response will be decoded using the codec registry specified when the app client was configured. If no codec registry was configured, a default codec registry will be used. The default codec registry supports the mappings specified here Also accepts a timeout in milliseconds. Use this for functions that may run longer than the client-wide default timeout (15 seconds by default).

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultClass - the class that the response should be decoded as.

Returns:

a Task containing the decoded value.

callFunction

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

Calls the specified Stitch service function, and decodes the response into an instance of the specified type. The response will be decoded using the codec registry given. Also accepts a timeout in milliseconds. Use this for functions that may run longer than the client-wide default timeout (15 seconds by default).

Type Parameters:

ResultT - the type into which the response will be decoded.

Parameters:

name - the name of the Stitch service function to call.

args - the arguments to pass to the function.

requestTimeout - the number of milliseconds the client should wait for a response from the server before failing with an error.

resultClass - the class that the response should be decoded as.

codecRegistry - the codec registry used for de/serialization of the function call.

Returns:

a Task containing the decoded value.

getCodecRegistry

CodecRegistry getCodecRegistry()

Get the codec registry that will be used to decode responses when a codec registry.

Returns:

the CodecRegistry

withCodecRegistry

StitchServiceClient withCodecRegistry(CodecRegistry codecRegistry)

Create a new StitchServiceClient instance with a different codec registry.

Parameters:

codecRegistry - the new CodecRegistry for the service client.

Returns:

a new StitchServiceClient instance with the different codec registry