me.adaptive.arp.api

Class APIRequest

java.lang.Object

me.adaptive.arp.api.APIRequest

public class APIRequest
extends java.lang.Object

Structure representing a HTML5 request to the native API.

Since:

v2.0

Constructor Summary

Constructors

Constructor and Description
APIRequest() Default constructor
APIRequest(java.lang.String bridgeType, java.lang.String methodName) Constructor with method name.
APIRequest(java.lang.String bridgeType, java.lang.String methodName, java.lang.String[] parameters, long asyncId) Constructor with all the parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiVersion() Returns the request's API version.
long	getAsyncId() Returns the callback or listener id assigned to this request OR zero if there is no associated callback or listener.
java.lang.String	getBridgeType() Bridge Type Getter
java.lang.String	getMethodName() Method name Getter
java.lang.String[]	getParameters() Parameters Getter
void	setApiVersion(java.lang.String apiVersion) Sets the request's API version.
void	setAsyncId(long asyncId) Sets the callback or listener id to the request.
void	setBridgeType(java.lang.String bridgeType) Bridge Type Setter
void	setMethodName(java.lang.String methodName) Method name Setter
void	setParameters(java.lang.String[] parameters) Parameters Setter

Methods inherited from class java.lang.Object

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

Constructor Detail

APIRequest

public APIRequest()

Default constructor

Since:

v2.0

APIRequest

public APIRequest(java.lang.String bridgeType,
                  java.lang.String methodName)

Constructor with method name. No parameters

Parameters:

bridgeType - Name of the bridge to be invoked.

methodName - Name of the method

Since:

v2.0

APIRequest

public APIRequest(java.lang.String bridgeType,
                  java.lang.String methodName,
                  java.lang.String[] parameters,
                  long asyncId)

Constructor with all the parameters

Parameters:

bridgeType - Name of the bridge to be invoked.

methodName - Name of the method

parameters - Array of parameters as JSON formatted strings.

asyncId - Id of callback or listener or zero if none for synchronous calls.

Since:

v2.0

Method Detail

getApiVersion

public java.lang.String getApiVersion()

Returns the request's API version. This should be the same or higher than the platform managing the request.

Returns:

String with the API version of the request.

setApiVersion

public void setApiVersion(java.lang.String apiVersion)

Sets the request's API version. This should be the same or higher than the platform managing the request.

Parameters:

apiVersion - String with the API version of the request.

getAsyncId

public long getAsyncId()

Returns the callback or listener id assigned to this request OR zero if there is no associated callback or listener.

Returns:

long with the unique id of the callback or listener, or zero if there is no associated async event.

setAsyncId

public void setAsyncId(long asyncId)

Sets the callback or listener id to the request.

Parameters:

asyncId - The unique id of the callback or listener.

getBridgeType

public java.lang.String getBridgeType()

Bridge Type Getter

Returns:

Bridge Type

Since:

v2.0

setBridgeType

public void setBridgeType(java.lang.String bridgeType)

Bridge Type Setter

Parameters:

bridgeType - Bridge Type

Since:

v2.0

getMethodName

public java.lang.String getMethodName()

Method name Getter

Returns:

Method name

Since:

v2.0

setMethodName

public void setMethodName(java.lang.String methodName)

Method name Setter

Parameters:

methodName - Method name

Since:

v2.0

getParameters

public java.lang.String[] getParameters()

Parameters Getter

Returns:

Parameters

Since:

v2.0

setParameters

public void setParameters(java.lang.String[] parameters)

Parameters Setter

Parameters:

parameters - Parameters, JSON formatted strings of objects.

Since:

v2.0