Index (Syndeo Scripting API)

A C D F G H I L M N P R S U V X
All Classes and Interfaces|All Packages|Constant Field Values

A

add(String, Object) - Method in interface cx.syndeo.script.Variables: Adds a new variable with the given key and value.
addExtraCard(String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates a new card with the given title and text (wrapped in a paragraph tag) and adds it to the extraCards list.
addExtraChoice(String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates a new context menu choice with the given visible text and postback answer, and adds it to the extraChoices list.
addExtraChoice(String, String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates a new context menu choice with the given visible text, postback answer, and associated file key, then adds it to the extraChoices list.
addExtraChoice(String, String, String, String, String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Constructs a new context menu choice with the provided properties and appends it to the extraChoices list.
addExtraChoice(String, String, String, String, String, String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates a new context menu choice with the given properties and adds it to the extraChoices list.
addExtraChoice(String, String, String, String, String, String, String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates a new context menu choice with the provided properties, validates the alternative text length, and adds the choice to the extraChoices list.
addHeader(String, String) - Method in interface cx.syndeo.script.HttpCallable: Adds a header to the HTTP request.
addVariable(String, Variable) - Method in interface cx.syndeo.script.Variables: Adds or replaces a full Variable under the given key.

C

cancelOutcome() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Cancels the current outcome and places the user back to the "start".
Channel - Interface in cx.syndeo.script: Represents a communication channel, providing details about the platform, name, and identifiers for the conversation.
checkScheduleStatus(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Identifies the current status of a Schedule, identified by its display name.
checkScheduleStatus(String, Long) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Identifies the status of a Schedule, identified by its display name.
clear() - Method in interface cx.syndeo.script.Messages: Removes all stored messages.
clear() - Method in interface cx.syndeo.script.Variables: Clears all stored variables.
cx.syndeo.entities.surveys - package cx.syndeo.entities.surveys
cx.syndeo.script - package cx.syndeo.script
cx.syndeo.script.api - package cx.syndeo.script.api
cx.syndeo.scripting.entities - package cx.syndeo.scripting.entities

D

delete() - Method in interface cx.syndeo.script.HttpCallable: Executes an HTTP DELETE request.
destroy(String) - Method in interface cx.syndeo.script.Variables: Removes a variable by key.
destroy(String) - Method in interface cx.syndeo.scripting.entities.SyndeoCache: Removes the entry for the given key from the cache.

F

FREE_TEXT - Enum constant in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Free text input.

G

get() - Method in interface cx.syndeo.script.HttpCallable: Executes an HTTP GET request.
get(String) - Method in interface cx.syndeo.script.Messages: Retrieves the message value for the given key.
get(String) - Method in interface cx.syndeo.script.Variables: Retrieves the raw value of a variable.
get(String) - Method in interface cx.syndeo.scripting.entities.ScriptProperties: Retrieves the value of the property with the given name.
get(String) - Method in interface cx.syndeo.scripting.entities.SyndeoCache: Retrieves the value associated with the given key.
getAll() - Method in interface cx.syndeo.script.Messages: Returns all stored messages.
getAll() - Method in interface cx.syndeo.script.Variables: Returns a map of all variable values (not the DTOs).
getAllVariables() - Method in interface cx.syndeo.script.Variables: Returns the full variable definitions.
getAnswer() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: When a post-conversation survey is configured a Question-Answered event is received.
getCache() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Returns the current SyndeoCache instance.
getChannel() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Returns details of the active Channel, through which this conversation is currently taking place.
getCompanyId() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: The unique ID representing the current company in the Syndeo platform.
getConversationHistory() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Retrieves the stored reporting data for the Conversation the script is being executed on.
getConversationId() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: The unique ID representing the conversation on the the Syndeo platform.
getId() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the unique identifier of the survey question.
getIntent() - Method in interface cx.syndeo.script.IntentResult: Retrieves the name of the recognized intent.
getIntents(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Function that analyses a sentence for Intents.
getLastStatusCode() - Method in interface cx.syndeo.script.HttpCallable: Gets the HTTP status code from the last executed call.
getMaxLength() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the maximum allowed length for text-based questions.
getMaxValue() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the maximum allowed value for numerical or range-based questions.
getMessages() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Messages are the prompts used within the configured flow.
getMinValue() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the minimum allowed value for numerical or range-based questions.
getName() - Method in interface cx.syndeo.entities.surveys.SurveyChoiceOption: The label shown to the user when the option is presented in a multiple choice question
getName() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the name of the survey question.
getName() - Method in interface cx.syndeo.script.Channel: The user configured name of the Syndeo Channel.
getOptions() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves a list of predefined choice options for multiple-choice or dropdown questions.
getParams() - Method in interface cx.syndeo.script.Variables: Direct access to internal param DTO map.
getPlatform() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: The name of the messaging or voice platform through which the conversation is currently taking place.
getPlatform() - Method in interface cx.syndeo.script.Channel: The name of the messaging or voice platform (e.g., "Web", "SMS").
getProperties() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Returns the current ScriptProperties instance.
getQuestion() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the actual question text.
getQuestion() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: When a post-conversation survey is configured a Question-Answered event is received.
getRandomUUID() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Generates a random UUID
getScore() - Method in interface cx.syndeo.script.IntentResult: Retrieves the confidence score of the recognized intent.
getSurveyId() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: When a post-conversation survey is configured a Question-Answered event is received.
getSurveyName() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: When a post-conversation survey is configured a Question-Answered event is received.
getTargetId() - Method in interface cx.syndeo.script.Channel: The unique identifier for the entity the user is communicating with on the platform (e.g.
getType() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the type of the survey question.
getUniqueUserId() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: The unique ID representing the conversation's user in the Syndeo platform.
getUserId() - Method in interface cx.syndeo.script.Channel: The unique ID for the user on the third-party platform.
getUuid() - Method in interface cx.syndeo.entities.surveys.SurveyQuestion: Retrieves the UUID (Universally Unique Identifier) of the survey question.
getValue() - Method in interface cx.syndeo.entities.surveys.SurveyChoiceOption: The value the answer will be set to when the user selects this option in a multiple choice question
getValue() - Method in interface cx.syndeo.script.Variable: Retrieves the current value of the variable.
getVariable(String) - Method in interface cx.syndeo.script.Variables: Retrieves the full Variable for the given key.
getVariables() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Returns the current Variables instance, which includes all variables currently in session.

H

has(String) - Method in interface cx.syndeo.scripting.entities.ScriptProperties: Checks whether a property with the given name exists.
has(String) - Method in interface cx.syndeo.scripting.entities.SyndeoCache: Checks whether the cache contains an entry for the given key.
HttpCallable - Interface in cx.syndeo.script: Interface for making HTTP calls.

I

IntentResult - Interface in cx.syndeo.script: Represents the result of an intent recognition process.
isMenuOption() - Method in interface cx.syndeo.script.IntentResult: Checks if the recognized intent corresponds to a menu option.
isRemembered() - Method in interface cx.syndeo.script.Variable: Checks if the variable's value should be remembered across sessions.
isSensitive() - Method in interface cx.syndeo.script.Variable: Checks if the variable's value is considered sensitive (e.g., a password or private key).
isTest() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Whether the conversation is taking place in a test channel.

L

log(String, Object...) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Logs a message and interpolated objects with log level INFO.

M

MAX_HTTP_READ_TIMEOUT_MS - Static variable in interface cx.syndeo.script.HttpCallable: The maximum allowed read timeout in milliseconds (120000ms or 2 minutes).
Messages - Interface in cx.syndeo.script: An interface for passing message strings by key.
MIN_HTTP_READ_TIMEOUT_MS - Static variable in interface cx.syndeo.script.HttpCallable: The minimum allowed read timeout in milliseconds (0).
MULTIPLE_CHOICE - Enum constant in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Multiple choice selection.

N

newLLMChat(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Function that initialises new Chat with a configured LLM.
newLLMChat(String, Map<String, Object>) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Function that initialises new Chat with a LLM.
NUMBER_RATING - Enum constant in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Numeric rating (e.g., 1-10, 0-100).

P

populateTextVariables(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Finds variables in the text (e.g.
post() - Method in interface cx.syndeo.script.HttpCallable: Executes an HTTP POST request.
prepareHttpCall(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Creates and prepares an HTTP call for the specified URL
put() - Method in interface cx.syndeo.script.HttpCallable: Executes an HTTP PUT request.

R

restartOutcome() - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Send the user back to the start of the current outcome.

S

ScriptProperties - Interface in cx.syndeo.scripting.entities: Provides access to named script properties, potentially involving cryptographic operations.
sendMessageToLLM(String, String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Send message to the LLM Session specified by the LLM Chat Session ID.
set(String, Object) - Method in interface cx.syndeo.script.Variables: Sets the value of an existing variable or creates a new one.
set(String, Object, Boolean) - Method in interface cx.syndeo.script.Variables: Sets a variable with sensitivity flag.
set(String, Object, Boolean, Boolean) - Method in interface cx.syndeo.script.Variables: Sets a variable with sensitivity and remembered flags.
set(String, String) - Method in interface cx.syndeo.script.Messages: Sets or replaces the message for the given key.
set(String, String) - Method in interface cx.syndeo.scripting.entities.SyndeoCache: Stores or updates the value for the given key.
setAll(Map<String, Object>) - Method in interface cx.syndeo.script.Variables: Replaces all variables with the given plain values.
setBody(String) - Method in interface cx.syndeo.script.HttpCallable: Sets the request body from a raw string.
setParams(Map<String, Variable>) - Method in interface cx.syndeo.script.Variables: Replaces the internal map of transfer variable DTOs.
setPath(Integer) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Sets the path to be followed according to the script's intended direction.
setQueryString(Object) - Method in interface cx.syndeo.script.HttpCallable: Sets the query string parameters for the URL from a Map.
setReadTimeout(long) - Method in interface cx.syndeo.script.HttpCallable: Set the read timeout value for the HTTP call.
setRemembered(Boolean) - Method in interface cx.syndeo.script.Variable: Sets whether the variable's value should be remembered across sessions.
setSensitive(Boolean) - Method in interface cx.syndeo.script.Variable: Sets whether the variable's value is considered sensitive.
setValue(Object) - Method in interface cx.syndeo.script.Variable: Sets the value of the variable.
size() - Method in interface cx.syndeo.script.Variables: Returns number of stored variables.
STAR_RATING - Enum constant in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Star rating (e.g., 1-5 stars).
SurveyChoiceOption - Interface in cx.syndeo.entities.surveys
SurveyQuestion - Interface in cx.syndeo.entities.surveys: Represents a single question within a survey.
SurveyQuestionType - Enum Class in cx.syndeo.entities.surveys: Enumerates the different types of survey questions that can be responded to by a user.
switchOutcome(int) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Send the user to a different outcome.
SyndeoCache - Interface in cx.syndeo.scripting.entities: Provides access to the string-based key/value Syndeo cache.
SyndeoScriptAPI - Interface in cx.syndeo.script.api: The SyndeoScriptAPI interface provides a comprehensive set of methods for interacting with the Syndeo platform within script environments.

U

UP_DOWN - Enum constant in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Up/down vote or thumbs up/down.

V

valueOf(String) - Static method in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class cx.syndeo.entities.surveys.SurveyQuestionType: Returns an array containing the constants of this enum class, in the order they are declared.
Variable - Interface in cx.syndeo.script: The Variable interface defines the contract for objects that represent a variable within a scripting context.
Variables - Interface in cx.syndeo.script: Interface for a container of variables.

X

xmlToJson(String) - Method in interface cx.syndeo.script.api.SyndeoScriptAPI: Converts XML string to JSON.

A C D F G H I L M N P R S U V X
All Classes and Interfaces|All Packages|Constant Field Values