Ballerina API Documentation

Functions of ballerina.lang.messages package

function addHeader(message m, string key, string value)

Adds a transport header to the message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object
keystringThe header name
valuestringThe header value

function clone(message m) (message )

Clones and creates a new instance of a message object

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
messageThe new instance of the message object

function getHeader(message m, string headerName) (string )

Gets a transport header from the message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object
headerNamestringThe header name

Return Parameters:

Return VariableData TypeDescription
stringThe header value

function getHeaders(message m, string headerName) (string[] )

Gets transport headers from the message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object
headerNamestringThe header name

Return Parameters:

Return VariableData TypeDescription
string[]string[]: The header values

function getJsonPayload(message m) (json )

Gets the message payload in JSON format

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
jsonThe JSON reresentation of the message payload

function getStringPayload(message m) (string )

Gets the message payload in string format

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
stringThe string representation of the message payload

function getStringValue(message m, string propertyName) (string )

To get the value for a string property in a map type message

Parameters:

Parameter NameData TypeDescription
mmessagemessage: message
propertyNamestringName of the property

Return Parameters:

Return VariableData TypeDescription
stringThe value of the map property

function getXmlPayload(message m) (xml )

Gets the message payload in XML format

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
xmlThe XML representation of the message payload

function removeHeader(message m, string key)

Removes a transport header from the message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object
keystringThe header name

function setHeader(message m, string key, string value)

Sets the value of a transport header

Parameters:

Parameter NameData TypeDescription
mmessageThe message object
keystringThe header name
valuestringThe header value

function setJsonPayload(message m, json payload)

Sets the message payload using a JSON object

Parameters:

Parameter NameData TypeDescription
mmessageThe current message object
payloadjsonThe JSON payload object

function setStringPayload(message m, string payload)

Sets the message payload using a string object

Parameters:

Parameter NameData TypeDescription
mmessageThe current message object
payloadstringThe string payload object

function setXmlPayload(message m, xml payload)

Sets the message payload using an XML object

Parameters:

Parameter NameData TypeDescription
mmessageThe current message object
payloadxmlThe XML payload object


Menu

  • Functions
    • addHeader(message m, string key, string value)
    • clone(message m) (message )
    • getHeader(message m, string headerName) (string )
    • getHeaders(message m, string headerName) (string[] )
    • getJsonPayload(message m) (json )
    • getStringPayload(message m) (string )
    • getStringValue(message m, string propertyName) (string )
    • getXmlPayload(message m) (xml )
    • removeHeader(message m, string key)
    • setHeader(message m, string key, string value)
    • setJsonPayload(message m, json payload)
    • setStringPayload(message m, string payload)
    • setXmlPayload(message m, xml payload)

Copyright 2017 Ballerina API Documentation