Tunnel

Method Summary
	deleteToken() Deletes the response token associated with this tunnel, if any.
Tunnel	setSafeBox(SafeBox safeBox) Sets the SafeBox for the remote end of the tunnel to use.
Tunnel	setWorkflow(String workflowName) Sets the target's tunnel workflow, if known.
TunnelResult	submit(String action, Payload payload) Submits a request to the tunnel's target.
TunnelResult	submitToken(String action, Payload payload) Submits a request to the tunnel's target and creates a response token if one doesn't already exist.
TunnelResult	submitToken(String action, String tunnelWorkflow, Payload payload) Submits a request to the tunnel's target and creates a response token if one doesn't already exist. This will also set the local workflow to run when there is a response and over-ride any already set (this is set permanently, not per request).
String	toString() Returns a description of this object.

Method Detail

deleteToken()

Deletes the response token associated with this tunnel, if any.

Since: 07-23-2019

top

Tunnel setSafeBox(SafeBox safeBox)

Sets the SafeBox for the remote end of the tunnel to use.

Parameters:

SafeBox safeBox Required parameter.

Returns: Tunnel

Since: 11-17-2022

top

Tunnel setWorkflow(String workflowName)

Sets the target's tunnel workflow, if known.

Parameters:

String workflowName Required parameter.

Returns: Tunnel

Since: 10-23-2019

top

TunnelResult submit(String action, Payload payload)

Submits a request to the tunnel's target.

Parameters:

String action
Payload payload

Returns: TunnelResult

Since: 06-18-2018

top

TunnelResult submitToken(String action, Payload payload)

Submits a request to the tunnel's target and creates a response token if one doesn't already exist.

Parameters:

String action
Payload payload

Returns: TunnelResult

Since: 07-23-2019

top

TunnelResult submitToken(String action, String tunnelWorkflow, Payload payload)

Submits a request to the tunnel's target and creates a response token if one doesn't already exist. This will also set the local workflow to run when there is a response and over-ride any already set (this is set permanently, not per request).

Parameters:

String action
String tunnelWorkflow Required parameter. Maximum allowed size of parameter: 255
Payload payload

Returns: TunnelResult

Since: 07-02-2020

top

String toString()

Returns a description of this object.

Returns: String

Since: 06-18-2018

top

API Date: Nov 18, 2024 01:04 PM