Skip navigation links
A B C G H I L N O R S T U V W 

A

action(SlangIntent, SlangSession) - Method in interface SlangIntentAction
The action method to be implemented by applications that are interested in being notified when an utterance spoken by the user is resolved into a SlangIntent by Slang.

B

build() - Method in class SlangBuddyOptions.Builder
Constructs a SlangBuddyOptions object from the current builder
Builder() - Constructor for class SlangBuddyOptions.Builder
Creates an empty Builder object

C

compareTo(SlangEntity) - Method in class SlangEntity
 
contains(String) - Method in class SlangAppProperties
Returns if a given key is present or not

G

get(String) - Method in class SlangAppProperties
Returns an app property value for a given key
getAffirmative() - Method in class SlangPrompt
Returns an affirmative response configured for this prompt.
getAffirmative(Locale) - Method in class SlangPrompt
Returns an affirmative response configured for this prompt.
getAffirmative() - Method in class SlangStatement
Returns an affirmative response configured for this prompt.
getAffirmative(Locale) - Method in class SlangStatement
Returns an affirmative response configured for this prompt.
getAffirmatives() - Method in class SlangPrompt
 
getAffirmatives() - Method in class SlangStatement
 
getAge() - Method in class SlangUserProperties
Returns the age of the user, if set
getAPIKey() - Method in class SlangBuddyOptions
Returns the API key of the account
getAppProperties() - Static method in class SlangBuddy
Returns the app-properties associatd with this buddy.
getAppProperties() - Method in class SlangBuddyOptions
Returns the app properties registered by the application
getBuddyId() - Method in class SlangBuddyOptions
Returns the ID of the buddy being initialized
getBuiltinUI() - Static method in class SlangBuddy
Returns the built-in Slang UI implementation
getCompletionStatement() - Method in class SlangIntent
Returns the completion statement configured for this intent
getContext() - Method in class SlangBuddyOptions
Returns the application's context
getCurrentActivity() - Method in interface SlangSession
Returns the current activity that's present on the application's screen
getCurrentLocale() - Method in interface SlangSession
Returns the current Slang locale active in the application
getCurrentLocale() - Method in interface SlangUIDelegate
Returns the current locale chosen by the user or the application
getDefaultLocale() - Method in class SlangBuddyOptions
Returns the default locale specified by the application
getDefaultLocale() - Method in interface SlangUIDelegate
Returns the default locale request by the application
getDescription() - Method in class SlangHelpItem
Returns the description of this help item
getEntities() - Method in class SlangIntent
Returns the list of entities configured for this intent.
getEntity(String) - Method in class SlangIntent
Returns an entity configured for this intent with the given name.
getEnvironment() - Method in class SlangBuddyOptions
Returns the environment specified by the application
getGender() - Method in class SlangUserProperties
Returns the gender associated with the user
getHelpDisplayThreshold() - Method in class SlangBuddyOptions
Returns the number of failed attempts after which to automatically show help
getHelpItems() - Method in interface SlangUIDelegate
Returns a collection of all help items associated with this application
getHelpItems(Set<String>) - Method in interface SlangUIDelegate
Returns a collectin of help items filtered by the given set of intent names
getIntent() - Method in class SlangEntity
Returns the instance of SlangIntent that this entity is a part of.
getIntentAction(String) - Static method in class SlangBuddy
Returns the action associated with a given intent
getIntentAction() - Method in class SlangBuddyOptions
Returns the intent action registered by the application
getIntentName() - Method in class SlangHelpItem
Returns the name of the SlangIntent associated with this help item.
getListener() - Method in class SlangBuddyOptions
Returns the Slang buddy listener registered by the application
getLocales() - Method in interface SlangUIDelegate
Returns the set of locales requested by the application
getMessage() - Method in class SlangBuddy.InitializationError
Returns the error message corresponding to this initialization error
getMessages() - Method in class SlangMessage
 
getMetadata() - Method in class SlangUserProperties
Returns metadata associated with the user
getName() - Method in class SlangEntity
Returns the name of this entity
getName() - Method in class SlangEntityType
Returns the name of the type
getName() - Method in class SlangIntent
Returns the name of the resolved intent
getNegative() - Method in class SlangPrompt
Returns a negative response configured for this prompt.
getNegative(Locale) - Method in class SlangPrompt
Returns a negative response configured for this prompt.
getNegative() - Method in class SlangStatement
Returns a negative response configured for this prompt.
getNegative(Locale) - Method in class SlangStatement
Returns a negative response configured for this prompt.
getNegatives() - Method in class SlangPrompt
 
getNegatives() - Method in class SlangStatement
 
getQuestion() - Method in class SlangPrompt
Returns a question configured for this prompt.
getQuestion(Locale) - Method in class SlangPrompt
Returns a question configured for this prompt.
getQuestions() - Method in class SlangPrompt
 
getRequestedLocales() - Method in class SlangBuddyOptions
Returns the locales requested by the application
getStartActivity() - Method in class SlangBuddyOptions
Returns the start activity specified by the app
getStartStatement() - Method in class SlangIntent
Returns the start statement configured for this intent.
getStatement() - Method in class SlangEntity
Returns the statement that's configured for this SlangEntity in the Slang Console
getSupportedLocales() - Static method in class SlangLocale
Returns all locales supported by Slang
getTextMessage() - Method in class SlangMessage
Returns an text message configured.
getTextMessage(Locale) - Method in class SlangMessage
Returns an text message configured.
getType() - Method in class SlangBuddy.InitializationError
Returns the error type corresponding to this initialization error
getType() - Method in class SlangEntity
Returns the type of this entity
getUIProvider() - Method in class SlangBuddyOptions
Returns the UI provider registered by the application
getUserProperties() - Static method in class SlangBuddy
Returns the user-properties associated with this buddy.
getUserProperties() - Method in class SlangBuddyOptions
Returns the user properties registered by the application
getUserUtterance() - Method in class SlangIntent
Returns the utterance spoken by the user to result in the given intent
getUtteranceAction() - Method in class SlangBuddyOptions
Returns the utterance action registered by the application
getUtterances() - Method in class SlangHelpItem
Returns the help utterances that are part of this help item
getValue() - Method in class SlangEntity
Returns the current value of this entity.

H

hasAffirmative() - Method in class SlangPrompt
Returns whether this prompt has a configured affirmative response or not
hasAffirmative(Locale) - Method in class SlangPrompt
Returns whether this prompt has a configured affirmative response or not
hasAffirmative() - Method in class SlangStatement
Returns whether this prompt has a configured affirmative response or not
hasAffirmative(Locale) - Method in class SlangStatement
Returns whether this prompt has a configured affirmative response or not
hasNegative() - Method in class SlangPrompt
Returns whether this prompt has a configured negative response or not
hasNegative(Locale) - Method in class SlangPrompt
Returns whether this prompt has a configured negative response or not
hasNegative() - Method in class SlangStatement
Returns whether this prompt has a configured negative response or not
hasNegative(Locale) - Method in class SlangStatement
Returns whether this prompt has a configured negative response or not
hasQuestion() - Method in class SlangPrompt
Returns whether this prompt has a configured question or not
hasQuestion(Locale) - Method in class SlangPrompt
Returns whether this prompt has a configured question or not
hasTextMessage() - Method in class SlangMessage
Returns whether text message is configured or not for current locale
hasTextMessage(Locale) - Method in class SlangMessage
Returns whether text message is configured or not for given locale
hide() - Method in interface SlangBuiltinUI
Hides the Slang UI
hideSlangBanner() - Method in interface SlangBuiltinUI
Hides the Slang banner from the UI.

I

in.slanglabs.platform - package in.slanglabs.platform
 
in.slanglabs.platform.action - package in.slanglabs.platform.action
 
in.slanglabs.platform.prompt - package in.slanglabs.platform.prompt
 
in.slanglabs.platform.ui - package in.slanglabs.platform.ui
 
initialize(SlangBuddyOptions) - Static method in class SlangBuddy
Initializes a Slang buddy, identified by a buddy-id and API key.
InsufficientPrivilegeException() - Constructor for exception SlangBuddy.InsufficientPrivilegeException
 
InvalidIntentException() - Constructor for exception SlangBuddy.InvalidIntentException
 
isInitialized() - Static method in class SlangBuddy
Returns if the current buddy is initialized or not.
isRequired() - Method in class SlangEntity
Returns whether this entity is required to resolve the intent or not
isResolved() - Method in class SlangEntity
Returns whether this entity has been resolved (either by the Slang framework or by the application)

L

LOCALE_ENGLISH_IN - Static variable in class SlangLocale
The English (India) locale
LOCALE_HINDI_IN - Static variable in class SlangLocale
The Hindi (India) locale

N

notifyActionCompleted(SlangAction.Status) - Method in interface SlangSession
Notifies the Slang platform that a previous action which was being waited upon is now complete
notifyUserCanceled() - Method in interface SlangUIDelegate
Notifies the Slang platform that the user canceled the current session
notifyUserChangedLocale(Locale) - Method in interface SlangUIDelegate
Notifies the Slang platform that the user changed the locale
notifyUserPressedBackButton() - Method in interface SlangUIDelegate
Notifies the Slang platform that the user pressed the back button
notifyUserStartedSession() - Method in interface SlangUIDelegate
Notifies the Slang platform that the user wants to start a conversation

O

onCreate(Activity, SlangUIDelegate) - Method in interface SlangUIProvider
Called by the Slang platform after initialization succeeds, and is ready to start receiving user inputs via the UI
onDestroy() - Method in interface SlangUIProvider
Called by the Slang platform to clean up and remove the UI
onDisabled(SlangException) - Method in interface SlangUIProvider
Called by the Slang platform when Slang initialization fails
onDismissed() - Method in interface SlangUIProvider
Called by the Slang platform when the UI needs to be dismissed
onHelpRequested() - Method in interface SlangUIProvider
Called by the Slang platform when help is requested, either by the user explicitly, or implicitly, based on certain signals.
onHelpRequested(Set<String>) - Method in interface SlangUIProvider
Called by the Slang platform when help is requested, either by the user explicitly, or implicitly, based on certain signals.
onInitializationFailed(SlangBuddy.InitializationError) - Method in interface SlangBuddy.Listener
 
onInitialized() - Method in interface SlangBuddy.Listener
 
onListeningEnded() - Method in interface SlangUIProvider
Called by the Slang platform when it stops listening to speech from the user.
onListeningError(String, Locale) - Method in interface SlangUIProvider
Called by the Slang platform when it encounters an error while listening to user's speech.
onListeningStarted() - Method in interface SlangUIProvider
Called by the Slang platform when it starts listening to user speech.
onListeningTimedOut() - Method in interface SlangUIProvider
Called by the Slang platform when it times out while listening to speech from the user.
onSlangProcessingEnded() - Method in interface SlangUIProvider
Called by the Slang platform whenever Slang is finished processing some data.
onSlangProcessingError(String, Locale) - Method in interface SlangUIProvider
Called by the Slang platform whenver it encounters an error while processing data.
onSlangProcessingStarted() - Method in interface SlangUIProvider
Called by the Slang platform whenever Slang is processing some data.
onSlangTextAvailable(String, Locale) - Method in interface SlangUIProvider
Called by the Slang platform whnever there is text to be displayed to the user
onUserSessionEnded() - Method in interface SlangUIProvider
Called by the Slang platform to indicate that a user session has ended, either successfully or due to an error.
onUserSessionStarted() - Method in interface SlangUIProvider
Called by the Slang platform soon after the user requests to start a conversation
onUserTextAvailable(String, Locale) - Method in interface SlangUIProvider
Called by the Slang platform when speech from the user had been converted into text.
onUtteranceDetected(String, SlangSession) - Method in interface SlangUtteranceAction
This method is called by the Slang platform whenever it detects an utterance spoken by the user, before attempting intent resolution.
onUtteranceUnresolved(String, SlangSession) - Method in interface SlangUtteranceAction
This method is called by the Slang platform whenever it is unable to resolve a user utterance into a SlangIntent
overrideAffirmative(String) - Method in class SlangPrompt
Overrides the affirmative response for this prompt.
overrideAffirmative(String, Locale) - Method in class SlangPrompt
Overrides the affirmative response for this prompt for given locale.
overrideAffirmative(String) - Method in class SlangStatement
Overrides the affirmative response for this prompt
overrideAffirmative(String, Locale) - Method in class SlangStatement
Overrides the affirmative response for this prompt for given locale
overrideNegative(String) - Method in class SlangPrompt
Overrides the negative response for this prompt.
overrideNegative(String, Locale) - Method in class SlangPrompt
Overrides the negative response for this prompt for given locale.
overrideNegative(String) - Method in class SlangStatement
Overrides the negative response for this prompt
overrideNegative(String, Locale) - Method in class SlangStatement
Overrides the negative response for this prompt for given locale
overrideQuestion(String) - Method in class SlangPrompt
Overrides the question for this prompt
overrideQuestion(String, Locale) - Method in class SlangPrompt
Overrides the question for this prompt for given locale
overrideTextMessage(String) - Method in class SlangMessage
Overrides the text messages to be spoken/displayed to the user.
overrideTextMessage(String, Locale) - Method in class SlangMessage
Overrides the text messages to be spoken/displayed to the user.
overrideTextMessages(String[]) - Method in class SlangMessage
Overrides the set of text messages to be spoken/displayed to the user.
overrideTextMessages(String[], Locale) - Method in class SlangMessage
Overrides the set of text messages to be spoken/displayed to the user.

R

requestIntentRecognition(String) - Method in interface SlangUIDelegate
Requests the Slang platform intent resolution on the given text
resolve(String) - Method in class SlangEntity
Sets the entity's value and marks it resolved

S

set(String, Object) - Method in class SlangAppProperties
Adds a new key-value pair to this object
setAPIKey(String) - Method in class SlangBuddyOptions.Builder
Sets the API key of the account, as configured in the Slang Console.
setAppProperties(SlangAppProperties) - Method in class SlangBuddyOptions.Builder
Sets the app properties for the app.
setAutomaticHelpDisplayThreshold(int) - Method in class SlangBuddyOptions.Builder
Sets the number of failed user utterances after which the Slang platform will automatically display a help message.
setBackgroundColor(int) - Method in interface SlangBuiltinUI
Sets the background color of the surface that displays the conversation between the user and Slang
setBuddyId(String) - Method in class SlangBuddyOptions.Builder
Sets the ID of the buddy, as configured in the Slang Console.
setCompletionStatement(SlangStatement) - Method in class SlangIntent
Sets the completion statement for this intent, thereby overriding the statement configured through the Slang Console.
setContext(Context) - Method in class SlangBuddyOptions.Builder
Sets the Android application context.
setDefaultLocale(Locale) - Method in class SlangBuddyOptions.Builder
Sets the default locale in which Slang will be available to the user in the application.
setEnvironment(SlangBuddy.Environment) - Method in class SlangBuddyOptions.Builder
Sets the environment in which the given buddy is expected to operate.
setImageResource(int) - Method in interface SlangBuiltinUI
Sets the image on the Slang UI component that receives user clicks to initiate a conversation with Slang
setIntentAction(SlangIntentAction) - Method in class SlangBuddyOptions.Builder
Sets the SlangIntentAction to be called by the Slang platform whenever it resolves an intent from a user utterance.
setIsDraggable(boolean) - Method in interface SlangBuiltinUI
Sets if the Slang UI is draggable or not
setListener(SlangBuddy.Listener) - Method in class SlangBuddyOptions.Builder
Sets a listener that listens to state changes in the SlangBuddy
setPosition(float, float, float, float) - Method in interface SlangBuiltinUI
Sets the absolute position of the Slang UI.
setPosition(SlangBuiltinUI.SlangUIPosition) - Method in interface SlangBuiltinUI
Sets the relative position of the Slang UI.
setPosition(SlangBuiltinUI.SlangUIPosition, int, int) - Method in interface SlangBuiltinUI
Sets the relative position of the Slang UI with offsets from the screen boundaries.
setRequestedLocales(Set<Locale>) - Method in class SlangBuddyOptions.Builder
Specifies the set of locales in which Slang will be available to the user in the application.
setSecondaryImageResource(int) - Method in interface SlangBuiltinUI
Sets the image on the Slang UI component that's displayed when Slang is listening to the user and processing user utterances
setStartActivity(Activity) - Method in class SlangBuddyOptions.Builder
Sets the initial activity on which to place the default Slang UI.
setStartStatement(SlangStatement) - Method in class SlangIntent
Sets the start statement for this intent, thereby overriding the statement configured through the Slang Console.
setTextColor(int) - Method in interface SlangBuiltinUI
Sets the color of the text displayed by Slang
setTypeface(Typeface) - Method in interface SlangBuiltinUI
Sets the typeface for the text displayed by Slang
setUIProvider(SlangUIProvider) - Method in class SlangBuddyOptions.Builder
Sets a custom UI provider.
setUserProperties(SlangUserProperties) - Method in class SlangBuddyOptions.Builder
Sets the user properties for the current user.
setUtteranceAction(SlangUtteranceAction) - Method in class SlangBuddyOptions.Builder
Sets the SlangUtteranceAction to be called by the Slang platform for processing user utterances.
show() - Method in interface SlangBuiltinUI
Shows the Slang UI
SlangAction - Interface in in.slanglabs.platform.action
This is the base interface to be implemented by all actions registered with Slang
SlangAction.Status - Enum in in.slanglabs.platform.action
 
SlangAppProperties - Class in in.slanglabs.platform
A utility class that can be used by the application to help fulfill dynamic statements.
SlangAppProperties() - Constructor for class SlangAppProperties
Creates an empty SlangAppProperties object
SlangAppProperties(Map<String, Object>) - Constructor for class SlangAppProperties
Creates a SlangAppProperties object seeded with the given properties
SlangBuddy - Class in in.slanglabs.platform
This class represents a Slang buddy configured in the Slang Console.
SlangBuddy() - Constructor for class SlangBuddy
 
SlangBuddy.Environment - Enum in in.slanglabs.platform
This enum represents the different environments in which a Slang buddy can operate.
SlangBuddy.InitializationError - Class in in.slanglabs.platform
This error is thrown when the Slang platform fails to initialize a buddy successfully.
SlangBuddy.InitializationError.Type - Enum in in.slanglabs.platform
 
SlangBuddy.InsufficientPrivilegeException - Exception in in.slanglabs.platform
This exception is thrown by the Slang platform when an application attempts to perform actions for which it does not have sufficient privileges.
SlangBuddy.InvalidIntentException - Exception in in.slanglabs.platform
This exception is raised when applications attempt to perform actions on intents that are not valid.
SlangBuddy.Listener - Interface in in.slanglabs.platform
This interface is expected to be implemented by applications that are interested in listening to the state of the Slang buddy, including if initialization succeeded, or failed and for what reason.
SlangBuddy.UninitializedUsageException - Exception in in.slanglabs.platform
This exception is raised when applications call SlangBuddy methods before the buddy is initialized successfully.
SlangBuddyOptions - Class in in.slanglabs.platform
This class is a utility class that collects all the options that can be passed to a Slang buddy during initialization.
SlangBuddyOptions.Builder - Class in in.slanglabs.platform
A helper class for building SlangBuddyOptions objects, used to initialize a SlangBuddy
SlangBuddyOptions.InvalidOptionException - Exception in in.slanglabs.platform
An exception to indicate that an invalid option has been passed during the creation of a SlangBuddyOptions object.
SlangBuiltinUI - Interface in in.slanglabs.platform.ui
This interface is implemented by the Slang platform and is not to be overridden by applications.
SlangBuiltinUI.SlangUIPosition - Enum in in.slanglabs.platform.ui
This enum specifies the various positions at which the Slang UI can be positioned on the application's screen
SlangEntity - Class in in.slanglabs.platform
A class that represents an instance of a Slang entity.
SlangEntityType - Class in in.slanglabs.platform
A class that represents the type of an entity.
SlangException - Exception in in.slanglabs.platform
A utility class that represents exceptions thrown by the Slang platform
SlangHelpItem - Class in in.slanglabs.platform.ui
A helper class to be used by applications providing their own UI by implementing the SlangUIProvider interfae.
SlangIntent - Class in in.slanglabs.platform
This class represents a Slang intent that has been resolved by the Slang platform from a spoken user utterance.
SlangIntent.Status - Enum in in.slanglabs.platform
 
SlangIntentAction - Interface in in.slanglabs.platform.action
This interface is expected to be implemented by applications that are interested in taking action upon intent resolution by the Slang platform.
SlangLocale - Class in in.slanglabs.platform
A helper class that provides utility methods related to locales
SlangLocale() - Constructor for class SlangLocale
 
SlangMessage - Class in in.slanglabs.platform.prompt
A class that represents a simple text message to be used by the Slang platform to show/speak out information to the user.
SlangPrompt - Class in in.slanglabs.platform.prompt
A class that represents a prompting system to used by the Slang platform to prompt for information from the user at relevant points in the intent resolution flow (such as unresolved entities).
SlangSession - Interface in in.slanglabs.platform
A class that contains details of the currently active Slang session
SlangStatement - Class in in.slanglabs.platform.prompt
A class that represents a statement system to be used by the Slang platform to show/speak out information to the user at appropriate points in the intent resolution lifecycle (such as intent completion, unexpected errors, etc).
SlangUIDelegate - Interface in in.slanglabs.platform.ui
An interface that acts as the delegate of the Slang platform for processing requests from a UI implementation.
SlangUIProvider - Interface in in.slanglabs.platform.ui
This is the interface to be implemented by applications that choose to provide their own UI, instead of using Slang's built-in in UI implementation.
SlangUserProperties - Class in in.slanglabs.platform
This class allows the application to provide additional information about the current user to the Slang platform so that this data can be correlated with other Slang usage information via the Slang Console
SlangUserProperties(SlangUserProperties.Gender, int, Map<String, String>) - Constructor for class SlangUserProperties
Constructs a user-properties object with the given gender, age and other metadata
SlangUserProperties(SlangUserProperties.Gender) - Constructor for class SlangUserProperties
Constructs a user-properties object with the given gender
SlangUserProperties(int) - Constructor for class SlangUserProperties
Constructs a user-properties object with the given age
SlangUserProperties(Map<String, String>) - Constructor for class SlangUserProperties
Constructs a user-properties objct with the given metadata
SlangUtteranceAction - Interface in in.slanglabs.platform.action
This interface is expected to be implemented by applications that are interested in being notified whenever user utterances are processed by Slang, or when user utterances cannot be resolved by Slang into a SlangIntent

T

toString() - Method in enum SlangBuddy.Environment
 

U

UninitializedUsageException() - Constructor for exception SlangBuddy.UninitializedUsageException
 

V

valueOf(String) - Static method in enum SlangAction.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SlangBuddy.Environment
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SlangBuddy.InitializationError.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SlangIntent.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum SlangBuiltinUI.SlangUIPosition
Returns the enum constant of this type with the specified name.
values() - Static method in enum SlangAction.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SlangBuddy.Environment
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SlangBuddy.InitializationError.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SlangIntent.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum SlangBuiltinUI.SlangUIPosition
Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForActionCompletion() - Method in interface SlangSession
Notifies the Slang platform to asynchronously wait for an action completion
A B C G H I L N O R S T U V W 
Skip navigation links