StitchServiceClient

public protocol StitchServiceClient

StitchServiceClient acts as a general purpose client for working with services that are not defined or well defined by this SDK. It has methods similar to the callFunction method on StitchAppClient.


                    
                    
                    callFunction(withName:withArgs:_:)

Calls the MongoDB Stitch function with the provided name and arguments.

Declaration

Swift

func callFunction(withName name: String, withArgs args: [BSONValue], _ completionHandler: @escaping (StitchResult<Void>) -> Void)

Parameters

`withName`	The name of the Stitch function to be called.
`withArgs`	The `BSONArray` of arguments to be provided to the function.
`completionHandler`	The completion handler to call when the function call is complete. This handler is executed on a non-main global `DispatchQueue`.


                    
                    
                    callFunction(withName:withArgs:withRequestTimeout:_:)

Calls the MongoDB Stitch function with the provided name and arguments. Also accepts a timeout. Use this for function that may run longer than the client-wide default timeout (15 seconds by default).

Declaration

Swift

func callFunction(withName name: String, withArgs args: [BSONValue], withRequestTimeout requestTimeout: TimeInterval, _ completionHandler: @escaping (StitchResult<Void>) -> Void)

Parameters

`withName`	The name of the Stitch function to be called.
`withArgs`	The `BSONArray` of arguments to be provided to the function.
`withRequestTimeout`	The number of seconds the client should wait for a response from the server before failing with an error.
`completionHandler`	The completion handler to call when the function call is complete. This handler is executed on a non-main global `DispatchQueue`.


                    
                    
                    callFunction(withName:withArgs:_:)

Calls the function for this service with the provided name and arguments.

Declaration

Swift

func callFunction<T: Decodable>(withName name: String, withArgs args: [BSONValue], _ completionHandler: @escaping (StitchResult<T>) -> Void)

Parameters

`withName`	The name of the function to be called.
`withArgs`	The `BSONArray` of arguments to be provided to the function.
`completionHandler`	The completion handler to call when the function call is complete. This handler is executed on a non-main global `DispatchQueue`.
`result`	The result of the function call as `T`, or `nil` if the function call failed.
`error`	An error object that indicates why the function call failed, or `nil` if the function call was successful.


                    
                    
                    callFunction(withName:withArgs:withRequestTimeout:_:)

Calls the function for this service with the provided name and arguments, as well as with a specified timeout. Use this for functions that may run longer than the client-wide default timeout (15 seconds by default).

Declaration

Swift

func callFunction<T: Decodable>(withName name: String, withArgs args: [BSONValue], withRequestTimeout requestTimeout: TimeInterval, _ completionHandler: @escaping (StitchResult<T>) -> Void)

Parameters

`withName`	The name of the function to be called.
`withArgs`	The `BSONArray` of arguments to be provided to the function.
`withRequestTimeout`	The number of seconds the client should wait for a response from the server before failing with an error.
`completionHandler`	The completion handler to call when the function call is complete. This handler is executed on a non-main global `DispatchQueue`.
`result`	The result of the function call as `T`, or `nil` if the function call failed.
`error`	An error object that indicates why the function call failed, or `nil` if the function call was successful.