Arguments for sending an HTTP request. More...

Public Member Functions
byte[]	getBinaryContent ()
	Gets the binary content to transfer over HTTP. More...

java.util.HashMap< String, String >	getHeaders ()
	Gets the headers to transfer over HTTP. More...

int	getMaxRetries ()
	Gets the maximum number of retries allowed. More...

fm.liveswitch.HttpMethod	getMethod ()
	Gets the HTTP method. More...

fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgs >	getOnRequestCreated ()
	Gets the callback to invoke once the outgoing HTTP request is created. More...

fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgs >	getOnResponseReceived ()
	Gets the callback to invoke once the incoming HTTP response has been received. More...

Object	getSender ()
	Gets the sender of the content, either a client or publisher. More...

String	getTextContent ()
	Gets the text content to transfer over HTTP. More...

int	getTimeout ()
	Gets the number of milliseconds to wait before timing out the HTTP transfer. More...

String	getUrl ()
	Gets the target URL for the HTTP request. More...

	HttpRequestArgs ()
	Initializes a new instance of the fm.liveswitch.HttpRequestArgs class with default values. More...

void	setBinaryContent (byte[] value)
	Sets the binary content to transfer over HTTP. More...

void	setHeaders (java.util.HashMap< String, String > value)
	Sets the headers to transfer over HTTP. More...

void	setMaxRetries (int value)
	Sets the maximum number of retries allowed. More...

void	setMethod (fm.liveswitch.HttpMethod value)
	Sets the HTTP method. More...

void	setOnRequestCreated (fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgs > value)
	Sets the callback to invoke once the outgoing HTTP request is created. More...

void	setOnResponseReceived (fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgs > value)
	Sets the callback to invoke once the incoming HTTP response has been received. More...

void	setSender (Object value)
	Sets the sender of the content, either a client or publisher. More...

void	setTextContent (String value)
	Sets the text content to transfer over HTTP. More...

void	setTimeout (int value)
	Sets the number of milliseconds to wait before timing out the HTTP transfer. More...

void	setUrl (String value)
	Sets the target URL for the HTTP request. More...

Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object >	getDynamicProperties ()
	Gets all dynamic properties on this instance. More...

Object	getDynamicValue (String key)
	Gets a property value from the local cache. More...

void	setDynamicValue (String key, Object value)
	Sets a property value in the local cache. More...

boolean	unsetDynamicValue (String key)
	Removes a property value from the local cache. More...

Additional Inherited Members
Protected Member Functions inherited from fm.liveswitch.Dynamic
	Dynamic ()

Protected Member Functions inherited from fm.liveswitch.Serializable
boolean	getIsDirty ()
	Gets a value indicating whether this instance is dirty. More...

	Serializable ()
	Initializes a new instance of the fm.liveswitch.Serializable class. More...

void	setIsDirty (boolean value)
	Sets a value indicating whether this instance is dirty. More...

Detailed Description

Arguments for sending an HTTP request.

Constructor & Destructor Documentation

◆ HttpRequestArgs()

fm.liveswitch.HttpRequestArgs.HttpRequestArgs ( )

Initializes a new instance of the fm.liveswitch.HttpRequestArgs class with default values.

Member Function Documentation

◆ getBinaryContent()

byte [] fm.liveswitch.HttpRequestArgs.getBinaryContent ( )

Gets the binary content to transfer over HTTP.

Overrides fm.liveswitch.HttpRequestArgs#getTextContent.

◆ getHeaders()

java.util.HashMap<String,String> fm.liveswitch.HttpRequestArgs.getHeaders ( )

Gets the headers to transfer over HTTP.

◆ getMaxRetries()

int fm.liveswitch.HttpRequestArgs.getMaxRetries ( )

Gets the maximum number of retries allowed.

◆ getMethod()

fm.liveswitch.HttpMethod fm.liveswitch.HttpRequestArgs.getMethod ( )

Gets the HTTP method.

◆ getOnRequestCreated()

fm.liveswitch.IAction1<fm.liveswitch.HttpRequestCreatedArgs> fm.liveswitch.HttpRequestArgs.getOnRequestCreated ( )

Gets the callback to invoke once the outgoing HTTP request is created.

See fm.liveswitch.HttpRequestCreatedArgs for callback argument details.

◆ getOnResponseReceived()

fm.liveswitch.IAction1<fm.liveswitch.HttpResponseReceivedArgs> fm.liveswitch.HttpRequestArgs.getOnResponseReceived ( )

Gets the callback to invoke once the incoming HTTP response has been received.

See fm.liveswitch.HttpResponseReceivedArgs for callback argument details.

◆ getSender()

Object fm.liveswitch.HttpRequestArgs.getSender ( )

Gets the sender of the content, either a client or publisher.

◆ getTextContent()

String fm.liveswitch.HttpRequestArgs.getTextContent ( )

Gets the text content to transfer over HTTP.

◆ getTimeout()

int fm.liveswitch.HttpRequestArgs.getTimeout ( )

Gets the number of milliseconds to wait before timing out the HTTP transfer.

Defaults to 15000 ms (15 seconds).

◆ getUrl()

String fm.liveswitch.HttpRequestArgs.getUrl ( )

Gets the target URL for the HTTP request.

◆ setBinaryContent()

void fm.liveswitch.HttpRequestArgs.setBinaryContent ( byte[] value )

Sets the binary content to transfer over HTTP.

Overrides fm.liveswitch.HttpRequestArgs#getTextContent.

◆ setHeaders()

void fm.liveswitch.HttpRequestArgs.setHeaders ( java.util.HashMap< String, String > value )

Sets the headers to transfer over HTTP.

◆ setMaxRetries()

void fm.liveswitch.HttpRequestArgs.setMaxRetries ( int value )

Sets the maximum number of retries allowed.

◆ setMethod()

void fm.liveswitch.HttpRequestArgs.setMethod ( fm.liveswitch.HttpMethod value )

Sets the HTTP method.

◆ setOnRequestCreated()

void fm.liveswitch.HttpRequestArgs.setOnRequestCreated ( fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgs > value )

Sets the callback to invoke once the outgoing HTTP request is created.

See fm.liveswitch.HttpRequestCreatedArgs for callback argument details.

◆ setOnResponseReceived()

void fm.liveswitch.HttpRequestArgs.setOnResponseReceived ( fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgs > value )

Sets the callback to invoke once the incoming HTTP response has been received.

See fm.liveswitch.HttpResponseReceivedArgs for callback argument details.

◆ setSender()

void fm.liveswitch.HttpRequestArgs.setSender ( Object value )

Sets the sender of the content, either a client or publisher.

◆ setTextContent()

void fm.liveswitch.HttpRequestArgs.setTextContent ( String value )

Sets the text content to transfer over HTTP.

◆ setTimeout()

void fm.liveswitch.HttpRequestArgs.setTimeout ( int value )

Sets the number of milliseconds to wait before timing out the HTTP transfer.