call

open fun call(httpMethod: String, function: String, version: Int, parameters: Map<String, String>): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

version

The version of the function to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

Throws

if the request could not be executed

the request was successful but returned a non success response code


open fun call(function: String, version: Int, parameters: Map<String, String>): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

function

The function name to call.

version

The version of the function to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String, parameters: Map<String, String>): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

Throws

if the request could not be executed


open fun call(function: String, parameters: Map<String, String>): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

function

The function name to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String, version: Int): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

version

The version of the function to call.

Throws

if the request could not be executed


open fun call(function: String, version: Int): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

function

The function name to call.

version

The version of the function to call.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

Throws

if the request could not be executed


open fun call(function: String): KeyValue

Manually calls the specified Web API function with the provided details. This method is synchronous.

Return

A KeyValue object representing the results of the Web API call.

Parameters

function

The function name to call.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String, version: Int, parameters: Map<String, String>, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

version

The version of the function to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.


open fun call(httpMethod: String, function: String, version: Int, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

version

The version of the function to call.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String, parameters: Map<String, String>, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed


open fun call(httpMethod: String, function: String, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

httpMethod

The http request method. Either "POST" or "GET".

function

The function name to call.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed


open fun call(function: String, version: Int, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

function

The function name to call.

version

The version of the function to call.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed


open fun call(function: String, parameters: Map<String, String>, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

function

The function name to call.

parameters

A map of string key value pairs representing arguments to be passed to the API.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed


open fun call(function: String, callback: Consumer<KeyValue>, error: Consumer<WebAPI.WebAPIRequestException>)

Manually calls the specified Web API function with the provided details. This method is asynchronous.

Parameters

function

The function name to call.

callback

the callback that will be called with the resulting KeyValue object.

error

the callback for handling response errors.

Throws

if the request could not be executed