Functions
-
azure.functions
| __register |
INTERNAL usage - registers a handler function. |
| createContext |
I
INTERNAL usage - creates function context. |
| getBallerinaValueFromInputData |
I
INTERNAL usage - Returns a converted Ballerina value from input data. |
| getBallerinaValueFromInputDataDoubleEscape |
I
INTERNAL usage - Returns the converted Ballerina value from input data - double escape. |
| getBinaryFromHTTPReq |
I
INTERNAL usage - Returns the binary payload from the HTTP request. |
| getBodyFromHTTPInputData |
INTERNAL usage - Returns the HTTP body value from input data. |
| getBytesFromInputData |
I
INTERNAL usage - Returns the binary value from input data. |
| getHTTPRequestFromInputData |
INTERNAL usage - Populates the HTTP request structure from an input data entry. |
| getHTTPRequestFromParams |
I
INTERNAL usage - Returns the HTTP request data. |
| getJsonFromHTTPReq |
I
INTERNAL usage - Returns the JSON payload from the HTTP request. |
| getJsonFromInputData |
I
INTERNAL usage - Returns the JSON value from input data. |
| getJsonFromInputDataDoubleEscaped |
I
INTERNAL usage - Returns the JSON value from input data - double escape. |
| getJsonFromMetadata |
I
INTERNAL usage - Returns a json value from metadata. |
| getMetadata |
I
INTERNAL usage - extracts the metadata. |
| getOptionalBallerinaValueFromInputDataDoubleEscape |
I
INTERNAL usage - Returns the optional converted Ballerina value from input data - double escape. |
| getOptionalBytesFromInputData |
I
INTERNAL usage - Returns the optional binary value from input data. |
| getOptionalStringConvertedBytesFromInputData |
I
INTERNAL usage - Returns the optional string value converted from input binary data. |
| getOptionalStringFromInputData |
I
INTERNAL usage - Returns the optional string value from input data. |
| getStringConvertedBytesFromInputData |
I
INTERNAL usage - Returns the string value converted from input binary data. |
| getStringFromHTTPReq |
I
INTERNAL usage - Returns the string payload from the HTTP request. |
| getStringFromInputData |
I
INTERNAL usage - Returns the string value from input data. |
| getStringFromMetadata |
I
INTERNAL usage - Returns a string value from metadata. |
| setBallerinaValueAsJsonReturn |
I
INTERNAL usage - Converts a Ballerina value to a JSON and set the return value. |
| setBlobOutput |
I
INTERNAL usage - Sets the Blob output. |
| setCosmosDBBallerinaValueAsJsonReturn |
I
INTERNAL usage - Converts a CosmosDS Ballerina value to a JSON and set the return value. |
| setCosmosDBJsonReturn |
I
INTERNAL usage - Sets the CosmosDS JSON return value. |
| setHTTPOutput |
I
INTERNAL usage - Sets the HTTP output. |
| setHTTPReturn |
I
INTERNAL usage - Sets the HTTP binding return value. |
| setJsonReturn |
I
INTERNAL usage - Sets the JSON return value. |
| setPureHTTPOutput |
I
INTERNAL usage - Sets the pure HTTP output. |
| setPureJsonOutput |
I
INTERNAL usage - Sets the pure JSON output. |
| setPureStringOutput |
I
INTERNAL usage - Sets the pure string output. |
| setStringOutput |
I
INTERNAL usage - Sets the string output. |
| setStringReturn |
I
INTERNAL usage - Sets the string return value. |
| setTwilioSmsOutput |
I
INTERNAL usage - Sets the Twilio output. |
INTERNAL usage - registers a handler function.
Parameters
- name string
-
The name of the function
- funcHandler FunctionHandler
-
The function handler
INTERNAL usage - creates function context.
Parameters
- hparams HandlerParams
-
The handler parameters
- populateMetadata boolean
-
The flag to populate metadata
-
Return Type
(Context | error) The function context
getBallerinaValueFromInputData
(HandlerParams params, string name, typedesc recordType)
returns anydata | errorINTERNAL usage - Returns a converted Ballerina value from input data.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The input data entry name
- recordType typedesc
-
The record type descriptor
-
Return Type
(anydata | error) The JSON value
getBallerinaValueFromInputDataDoubleEscape
(HandlerParams params, string name, typedesc recordType)
returns anydata? | errorINTERNAL usage - Returns the converted Ballerina value from input data - double escape.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The input data entry name
- recordType typedesc
-
The record type descriptor
-
Return Type
(anydata? | error) The JSON value
INTERNAL usage - Returns the binary payload from the HTTP request.
Parameters
- params HandlerParams
-
The handler parameters
-
Return Type
(byte[] | error) The binary payload
INTERNAL usage - Returns the HTTP body value from input data.
-
Return Type
(string | error) The HTTP body
INTERNAL usage - Returns the binary value from input data.
-
Return Type
(byte[] | error) The binary value
INTERNAL usage - Populates the HTTP request structure from an input data entry.
-
Return Type
(HTTPRequest | error) The HTTP request
INTERNAL usage - Returns the HTTP request data.
Parameters
- params HandlerParams
-
The handler parameters
-
Return Type
(Request | error) The HTTP request
INTERNAL usage - Returns the JSON payload from the HTTP request.
Parameters
- params HandlerParams
-
The handler parameters
-
Return Type
(json | error) The JSON payload
INTERNAL usage - Returns the JSON value from input data.
-
Return Type
(json | error) The JSON value
INTERNAL usage - Returns the JSON value from input data - double escape.
-
Return Type
(json | error) The JSON value
INTERNAL usage - Returns a json value from metadata.
-
Return Type
(json | error) The metadata entry value
INTERNAL usage - extracts the metadata.
Parameters
- hparams HandlerParams
-
The handler parameters
-
Return Type
(json | error) The metadata JSON
getOptionalBallerinaValueFromInputDataDoubleEscape
(HandlerParams params, string name, typedesc recordType)
returns anydata? | errorINTERNAL usage - Returns the optional converted Ballerina value from input data - double escape.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The input data entry name
- recordType typedesc
-
The record type descriptor
-
Return Type
(anydata? | error) The JSON value
INTERNAL usage - Returns the optional binary value from input data.
-
Return Type
(byte[]? | error) The optional string value
getOptionalStringConvertedBytesFromInputData
(HandlerParams params, string name)
returns string? | errorINTERNAL usage - Returns the optional string value converted from input binary data.
-
Return Type
(string? | error) The optional binary value
INTERNAL usage - Returns the optional string value from input data.
-
Return Type
(string? | error) The optional string value
INTERNAL usage - Returns the string value converted from input binary data.
-
Return Type
(string | error) The string value
INTERNAL usage - Returns the string payload from the HTTP request.
Parameters
- params HandlerParams
-
The handler parameters
-
Return Type
(string | error) The string payload
INTERNAL usage - Returns the string value from input data.
-
Return Type
(string | error) The string value
INTERNAL usage - Returns a string value from metadata.
-
Return Type
(string | error) The metadata entry value
INTERNAL usage - Converts a Ballerina value to a JSON and set the return value.
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the Blob output.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The parameter name
- binding any
-
The binding data
-
Return Type
(error?) An error in failure
setCosmosDBBallerinaValueAsJsonReturn
(HandlerParams params, anydata value, string partitionKey)
returns error?INTERNAL usage - Converts a CosmosDS Ballerina value to a JSON and set the return value.
Parameters
- params HandlerParams
-
The handler parameters
- value anydata
-
The value
- partitionKey string
-
The partition key
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the CosmosDS JSON return value.
Parameters
- params HandlerParams
-
The handler parameters
- value json
-
The JSON return value
- partitionKey string
-
The partition key
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the HTTP output.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The parameter name
- binding HTTPBinding
-
The binding data
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the HTTP binding return value.
Parameters
- params HandlerParams
-
The handler parameters
- binding HTTPBinding
-
The HTTP binding return value
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the JSON return value.
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the pure HTTP output.
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the pure JSON output.
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the pure string output.
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the string output.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The parameter name
- binding StringOutputBinding
-
The binding data
-
Return Type
(error?) An error in failure
INTERNAL usage - Sets the string return value.
-
Return Type
(error?) An error in failure
setTwilioSmsOutput
(HandlerParams params, string name, TwilioSmsOutputBinding binding)
returns error?INTERNAL usage - Sets the Twilio output.
Parameters
- params HandlerParams
-
The handler parameters
- name string
-
The parameter name
- binding TwilioSmsOutputBinding
-
The binding data
-
Return Type
(error?) An error in failure