public interface IndyAPI
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
cacheGet(java.lang.String sKey_p)
Retrieve an item placed in the user cache.
|
void |
cachePut(java.lang.String sKey_p,
java.io.Serializable value_p,
int iExpiryTimeSecs_p)
Place an item in the user cache.
|
java.lang.String |
escapeJavaScript(java.lang.String sText_p) |
java.lang.String |
escapeUrl(java.lang.String sText_p) |
java.lang.String |
escapeXml(java.lang.String sText_p) |
java.lang.String |
formatCurrency(java.lang.String sCurrencyCode_p,
java.math.BigDecimal currencyAmount_p)
Create a correctly formatted currency String by passing in an ISO 4217 currency code and a BigDecimal amount.
|
java.lang.String |
formatCurrency(java.lang.String sCurrencyCode_p,
java.lang.String sCurrencyAmount_p)
Create a correctly formatted currency String by passing in an ISO 4217 currency code and a String amount.
|
java.lang.String |
formatDate(java.util.Date date_p)
Format a date into the standard GAAP format (i.e yyyy-MM-dd) using the system timezone.
|
java.lang.String |
formatDate(java.util.Date date_p,
java.lang.String sFormat_p)
Format a date into the standard GAAP format (i.e.
|
java.lang.String |
formatDate(java.util.Date date_p,
java.lang.String sFormat_p,
java.time.ZoneId timezone_p)
Format a date into a specified format with a specified timezone
|
java.lang.String |
formatDate(java.util.Date date_p,
java.time.ZoneId timezone_p)
Format a date into a specified format using the system timezone.
|
java.math.BigDecimal |
getCurrencyAmount(java.lang.String sSpeechStormCurrency_p)
Retrieve the amount from a GAAP formatted currency String (e.g.
|
java.lang.String |
getCurrencyCode(java.lang.String sSpeechStormCurrency_p)
Retrieve the ISO 4217 from a GAAP formatted currency String (e.g.
|
com.speechstorm.fish.scripting.AsyncResponse |
getLastBackendCallResult()
Returns the result of the last backend request.
|
int |
getRandomPercentage()
Returns a random percentage which can be used for routing a given number of calls in different directions.
|
java.util.Set<java.lang.String> |
getResponseTemplateNames()
Returns a Set containing the names of the response templates configured in the Integration Hub GUI
|
java.time.ZoneId |
getTimeZone(java.lang.String sTimeZoneName_p)
Returns the ZoneId value of a specified timezone name.
|
java.lang.Object |
getVariable(java.lang.String sName_p)
Get the value of a variable held in session by it's name
|
java.util.Collection<java.lang.String> |
getVariableNames()
Return a Collection containing the variable names which are currently held in session.
|
com.speechstorm.http.async.AsyncHttpResponse |
http(java.lang.String sURL_p,
java.lang.String sMethod_p,
java.util.List<java.lang.String> headers_p,
java.util.Map<java.lang.String,java.lang.String> params_p,
int iTimeoutMillis_p)
Makes a HTTP request to a specified web service URL containing key/value pair parameters.
|
com.speechstorm.http.async.AsyncHttpResponse |
http(java.lang.String sURL_p,
java.lang.String sMethod_p,
java.util.List<java.lang.String> headers_p,
java.lang.String sRequestBody_p,
java.lang.String sContentType_p,
int iTimeoutMillis_p)
Makes a HTTP request to a specified web service URL containing a request body and content type.
|
void |
logDebug(java.lang.String sMessage_p,
java.lang.Object... additionalItems_p)
Write a debug statement to the logs.
|
void |
logError(java.lang.String sMessage_p,
java.lang.Object... additionalItems_p)
Write an error statement to the logs.
|
void |
logError(java.lang.Throwable error_p,
java.lang.String sMessage_p,
java.lang.Object... additionalItems_p)
Write an error statement to the logs including a Throwable object.
|
void |
logInfo(java.lang.String sMessage_p,
java.lang.Object... additionalItems_p)
Write an info statement to the logs.
|
void |
logWarning(java.lang.String sMessage_p,
java.lang.Object... additionalItems_p)
Write a warning statement to the logs.
|
java.util.Date |
parseDate(java.lang.String sSpeechStormDate_p)
Parse a date in the standard GAAP format (i.e yyyy-MM-dd) using the system timezone.
|
java.util.Date |
parseDate(java.lang.String sDate_p,
java.lang.String sFormat_p)
Parse a date in a specified format using the system timezone.
|
java.util.Date |
parseDate(java.lang.String sDate_p,
java.lang.String sFormat_p,
java.time.ZoneId timezone_p)
Parse a date with a specified format and timezone
|
java.util.Date |
parseDate(java.lang.String sSpeechStormDate_p,
java.time.ZoneId timezone_p)
Parse a date in the standard GAAP format (i.e.
|
net.sf.json.JSON |
parseJSON(java.lang.String sJSON_p)
Parses a provided JSON String into a JSON object.
|
groovy.util.Node |
parseXML(java.lang.String sXML_p)
Parses a provided XML String into a Node object.
|
void |
runHelper(java.lang.String sName_p) |
void |
selectResponseTemplate(java.lang.String sResponseTemplateName_p)
Sets the response template to use when responding to the VUI
|
com.speechstorm.fish.scripting.AsyncResponse |
sendEmail(java.util.List<java.lang.String> recipients_p,
java.lang.String sFromAddress_p,
java.lang.String sSubject_p,
java.lang.String sMessage_p)
Send an email.
|
com.speechstorm.fish.scripting.AsyncResponse |
sendSMS(java.lang.String sRecipientNumber_p,
java.lang.String sSenderNumber_p,
java.lang.String sMessage_p)
Send an SMS.
|
void |
setVariable(java.lang.String sName_p,
java.lang.Object value_p)
Add a variable to the session.
|
com.speechstorm.http.async.AsyncHttpResponse |
soap(java.lang.String sURL_p,
java.lang.String sSoapAction_p,
java.util.List<java.lang.String> headers_p,
java.lang.String sXML_p,
int iTimeoutMillis_p) |
com.speechstorm.fish.indy.sql.AsyncSqlResponse |
sqlDelete(java.lang.String sConnectionName_p,
int iTimeoutMillis_p,
java.lang.String sQuery_p,
java.lang.Object... parameters_p) |
com.speechstorm.fish.indy.sql.AsyncSqlResponse |
sqlInsert(java.lang.String sConnectionName_p,
int iTimeoutMillis_p,
java.lang.String sQuery_p,
java.lang.Object... parameters_p) |
com.speechstorm.fish.indy.sql.AsyncSqlRowsResponse |
sqlSelect(java.lang.String sConnectionName_p,
int iTimeoutMillis_p,
java.lang.String sQuery_p,
java.lang.Object... parameters_p) |
com.speechstorm.fish.indy.sql.AsyncSqlRowsResponse |
sqlStoredProcedure(java.lang.String sConnectionName_p,
int iTimeoutMillis_p,
java.lang.String sStoredProcedureName_p,
java.lang.Object... parameters_p) |
com.speechstorm.fish.indy.sql.AsyncSqlResponse |
sqlUpdate(java.lang.String sConnectionName_p,
int iTimeoutMillis_p,
java.lang.String sQuery_p,
java.lang.Object... parameters_p) |
java.lang.String |
unescapeJavaScript(java.lang.String sText_p) |
java.lang.String |
unescapeUrl(java.lang.String sText_p) |
java.lang.String |
unescapeXml(java.lang.String sText_p) |
com.speechstorm.http.async.AsyncHttpResponse http(java.lang.String sURL_p, java.lang.String sMethod_p, java.util.List<java.lang.String> headers_p, java.lang.String sRequestBody_p, java.lang.String sContentType_p, int iTimeoutMillis_p) throws java.lang.Exception
sURL_p
- sMethod_p
- e.g. POST, PUT, GETheaders_p
- sRequestBody_p
- sContentType_p
- iTimeoutMillis_p
- java.lang.Exception
com.speechstorm.http.async.AsyncHttpResponse http(java.lang.String sURL_p, java.lang.String sMethod_p, java.util.List<java.lang.String> headers_p, java.util.Map<java.lang.String,java.lang.String> params_p, int iTimeoutMillis_p) throws java.lang.Exception
sURL_p
- sMethod_p
- headers_p
- params_p
- iTimeoutMillis_p
- java.lang.Exception
com.speechstorm.http.async.AsyncHttpResponse soap(java.lang.String sURL_p, java.lang.String sSoapAction_p, java.util.List<java.lang.String> headers_p, java.lang.String sXML_p, int iTimeoutMillis_p) throws java.lang.Exception
java.lang.Exception
com.speechstorm.fish.scripting.AsyncResponse sendSMS(java.lang.String sRecipientNumber_p, java.lang.String sSenderNumber_p, java.lang.String sMessage_p) throws java.lang.Exception
sRecipientNumber_p
- sSenderNumber_p
- sMessage_p
- java.lang.Exception
com.speechstorm.fish.scripting.AsyncResponse sendEmail(java.util.List<java.lang.String> recipients_p, java.lang.String sFromAddress_p, java.lang.String sSubject_p, java.lang.String sMessage_p) throws java.lang.Exception
recipients_p
- sFromAddress_p
- sSubject_p
- sMessage_p
- java.lang.Exception
com.speechstorm.fish.indy.sql.AsyncSqlRowsResponse sqlSelect(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p) throws java.lang.Exception
java.lang.Exception
com.speechstorm.fish.indy.sql.AsyncSqlResponse sqlUpdate(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p) throws java.lang.Exception
java.lang.Exception
com.speechstorm.fish.indy.sql.AsyncSqlResponse sqlInsert(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p) throws java.lang.Exception
java.lang.Exception
com.speechstorm.fish.indy.sql.AsyncSqlResponse sqlDelete(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sQuery_p, java.lang.Object... parameters_p) throws java.lang.Exception
java.lang.Exception
com.speechstorm.fish.indy.sql.AsyncSqlRowsResponse sqlStoredProcedure(java.lang.String sConnectionName_p, int iTimeoutMillis_p, java.lang.String sStoredProcedureName_p, java.lang.Object... parameters_p) throws java.lang.Exception
java.lang.Exception
void logDebug(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)
sMessage_p
- additionalItems_p
- void logInfo(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)
sMessage_p
- additionalItems_p
- void logWarning(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)
sMessage_p
- additionalItems_p
- void logError(java.lang.String sMessage_p, java.lang.Object... additionalItems_p)
sMessage_p
- additionalItems_p
- void logError(java.lang.Throwable error_p, java.lang.String sMessage_p, java.lang.Object... additionalItems_p)
error_p
- sMessage_p
- additionalItems_p
- com.speechstorm.fish.scripting.AsyncResponse getLastBackendCallResult()
net.sf.json.JSON parseJSON(java.lang.String sJSON_p)
sJSON_p
- groovy.util.Node parseXML(java.lang.String sXML_p)
sXML_p
- java.util.Set<java.lang.String> getResponseTemplateNames()
void selectResponseTemplate(java.lang.String sResponseTemplateName_p)
sResponseTemplateName_p
- int getRandomPercentage()
java.lang.Object cacheGet(java.lang.String sKey_p)
sKey_p
- void cachePut(java.lang.String sKey_p, java.io.Serializable value_p, int iExpiryTimeSecs_p)
sKey_p
- value_p
- iExpiryTimeSecs_p
- java.util.Collection<java.lang.String> getVariableNames()
java.lang.Object getVariable(java.lang.String sName_p)
sName_p
- void setVariable(java.lang.String sName_p, java.lang.Object value_p)
sName_p
- value_p
- void runHelper(java.lang.String sName_p)
java.lang.String getCurrencyCode(java.lang.String sSpeechStormCurrency_p)
sSpeechStormCurrency_p
- java.math.BigDecimal getCurrencyAmount(java.lang.String sSpeechStormCurrency_p)
sSpeechStormCurrency_p
- java.lang.String formatCurrency(java.lang.String sCurrencyCode_p, java.lang.String sCurrencyAmount_p)
sCurrencyCode_p
- sCurrencyAmount_p
- java.lang.String formatCurrency(java.lang.String sCurrencyCode_p, java.math.BigDecimal currencyAmount_p)
sCurrencyCode_p
- currencyAmount_p
- java.time.ZoneId getTimeZone(java.lang.String sTimeZoneName_p)
sTimeZoneName_p
- Should use the format "area/city" for example "Europe/Paris" or "America/New York"java.util.Date parseDate(java.lang.String sSpeechStormDate_p)
sSpeechStormDate_p
- java.util.Date parseDate(java.lang.String sSpeechStormDate_p, java.time.ZoneId timezone_p)
sSpeechStormDate_p
- timezone_p
- java.util.Date parseDate(java.lang.String sDate_p, java.lang.String sFormat_p)
sDate_p
- sFormat_p
- java.util.Date parseDate(java.lang.String sDate_p, java.lang.String sFormat_p, java.time.ZoneId timezone_p)
sDate_p
- sFormat_p
- timezone_p
- java.lang.String formatDate(java.util.Date date_p)
date_p
- java.lang.String formatDate(java.util.Date date_p, java.lang.String sFormat_p)
date_p
- sFormat_p
- java.lang.String formatDate(java.util.Date date_p, java.time.ZoneId timezone_p)
date_p
- timezone_p
- java.lang.String formatDate(java.util.Date date_p, java.lang.String sFormat_p, java.time.ZoneId timezone_p)
date_p
- sFormat_p
- timezone_p
- java.lang.String escapeXml(java.lang.String sText_p)
sText_p
- java.lang.String unescapeXml(java.lang.String sText_p)
sText_p
- java.lang.String escapeJavaScript(java.lang.String sText_p)
sText_p
- java.lang.String unescapeJavaScript(java.lang.String sText_p)
sText_p
- java.lang.String escapeUrl(java.lang.String sText_p)
sText_p
- java.lang.String unescapeUrl(java.lang.String sText_p)
sText_p
-