ION functions
IONAddRequestContent
Declaration
void IONAddRequestContent(IONRequestMessage request, string content)Description
Adds json content to the given ION API request.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
request
|
Request to add json content.
|
content
|
Json content.
|
Return Value
Does not return a value.
IONAddRequestParameter
Declaration
void IONAddRequestParameter(RequestParameterType type, IONRequestMessage request, string name, string value)Description
Adds a parameter to the given ION API request.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
type
|
Parameter type.
|
request
|
Request to add parameter.
|
name
|
Parameter name.
|
value
|
Parameter value.
|
Return Value
Does not return a value.
IONCreateRequestMessage
Declaration
IONRequestMessage IONCreateRequestMessage(string serviceAccount, RequestMethodType methodType, string suite, string product, string restPath)Description
Creates a new ION API request instance.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
serviceAccount
|
Name of the service account on behalf of which the request will be called.
|
methodType
|
Type of request method.
|
suite
|
Name of ION API suite.
|
product
|
Name of product in ION API suite.
|
restPath
|
Path of ION API operation.
|
Return Value
New IONRequestMessage instance.
IONGetResponseContent
Declaration
string IONGetResponseContent(IONResponse response)Description
Gets the content of a response as a string.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
response
|
Response of which content should be returned.
|
Return Value
Content of a response.
IONGetResponseStatus
Declaration
int IONGetResponseStatus(IONResponse response)Description
Gets the status code of a response.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
response
|
Response of which status code should be returned.
|
Return Value
Status code of a response.
IONGetResponseSuccess
Declaration
bool IONGetResponseSuccess(IONResponse response)Description
Returns the success of a response.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
response
|
Response of which success should be returned.
|
Return Value
Success of a response.
IONPublishMessage
Declaration
void IONPublishMessage(string message)Description
Publishes custom message through ION Messaging Service as AnyDocument type.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
message
|
Message to publish.
|
Return Value
Does not return a value.
IONPublishMessage
Declaration
void IONPublishMessage(string documentType, string message)Description
Publishes custom message through ION Messaging Service.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
documentType
|
Document type.
|
message
|
Message to publish.
|
Return Value
Does not return a value.
IONPublishMessage
Declaration
void IONPublishMessage(string documentType, string message, string lid)Description
Publishes custom message through ION Messaging Service.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
documentType
|
Document type.
|
message
|
Message to publish.
|
lid
|
Logical ID identifying message publisher.
|
Return Value
Does not return a value.
IONSendRequestMessage
Declaration
IONResponse IONSendRequestMessage(IONRequestMessage request)Description
Sends given request to ION API.
Supported Runtime Versions
5.0
Parameters
|
Description
|
|---|---|
request
|
Request to send.
|
Return Value
Instance of IONResponse.