java.lang.Object
- oracle.cloud.bots.mobile.core.Bots

```
public final class Bots
extends java.lang.Object
```
The SDK entry point from which various services can be accessed.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String Version

Constructor Summary

Constructors
Constructor Description

Bots()

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static void`	`cancelTTS()`	Stops reading the skill's response aloud.
`static boolean`	`clearConversationHistory()`	Clears the conversation history.
`static void`	`clearConversationHistory(ClearConversationCallback clearConversationCallback)`	Clears the conversation history.
`static boolean`	`clearUnreadCount()`	Resets the count of the unread messages to `0`
`static void`	`connect()`	Reconnects the SDK with previous BotsConfiguration.
`static void`	`connect(BotsConfiguration botsConfiguration)`	Reconnects the SDK with new BotsConfiguration
`static void`	`destroy()`	Terminates all the SDK facilities.
`static void`	`disconnect()`	Disconnect the SDK
`static void`	`endChat()`	Ends the current session of user.
`static AgentDetails`	`getAgentDetails()`	Returns the current agent details for a particular agent session.
`static java.util.List<Message>`	`getAllConversations()`	Returns the list of the conversation messages.
`static BotsConfiguration`	`getBotsConfiguration()`	Returns the configuration object that's used to initialize the SDK with enabled features.
`static ConnectionStatus`	`getConnectionStatus()`	Returns the current status of the WebSocket's connection to the skill.
`static oracle.cloud.bots.mobile.core.internals.MultiLangChatConfiguration`	`getMultiLangChatConfiguration()`
`static int`	`getReconnectAttemptsExhausted()`	Returns the number of attempts exhausted for establishing connection.
`static oracle.cloud.bots.mobile.core.SpeechSynthesisSetting`	`getTTSVoice()`	Returns the voice that is used for speaking the utterances.
`static java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting>`	`getTTSVoices()`	Returns list of all voices present in speech engine used to initialise Speech Synthesis Service object.
`static int`	`getUnreadCount()`	Returns the count of unread messages.
`static void`	`init(android.app.Application application, java.lang.String url, java.lang.String channelId, java.lang.String userId, BotsCallback botsCallback)`	Initializes the SDK with the default configuration.
`static void`	`init(android.app.Application application, java.lang.String url, AuthenticationTokenProvider authTokenProvider, BotsCallback botsCallback)`	Initializes the SDK with the default configuration.
`static void`	`init(android.app.Application application, BotsConfiguration botsConfiguration)`	Initializes the SDK with the provided configuration.
`static void`	`init(android.app.Application application, BotsConfiguration botsConfiguration, BotsCallback botsCallback)`	Initializes the SDK with the provided configuration.
`static void`	`initSpeechSynthesisService()`	Initializes the speech synthesis service.
`static boolean`	`isInitialized()`	Checks if the SDK has been initialized or not.
`static boolean`	`isRecording()`	Checks if the voice recording has started or not.
`static boolean`	`isSpeaking()`	Deprecated. As of release 21.08, replaced by `isTTSSpeaking()`
`static boolean`	`isTTSSpeaking()`	Checks if the skill's response is currently being read aloud or not.
`static void`	`sendAttachment(FileWrapper attachment)`	Sends the uploaded attachment to the skill.
`static void`	`sendLocation(Geolocation geoLocation)`	Sends the location coordinates to the skill.
`static void`	`sendMessage(java.lang.String text)`	Sends a text message to the skill.
`static void`	`sendMessage(java.lang.String text, org.json.JSONObject metadata)`	Sends the text message and the metadata to the skill.
`static void`	`sendMessage(MessagePayload messagePayload)`	Sends a message to the skill.
`static void`	`sendPostBack(PostBackAction postBack)`	Sends the postback message to the skill.
`static void`	`sendUserTypingStatus(TypingStatus status, java.lang.String text)`
`static void`	`setAgentDetails(AgentDetails agentDetails)`	Sets the agent details dynamically.
`static void`	`setEventListener(EventListener eventListener)`	Sets the listener to receive the response returned from the skill, message sent to the skill, to get updates on connection status change, and to receive an update when attachment upload is complete.
`static void`	`setPrimaryChatLanguage(java.lang.String languageTag)`	Sets the language tag to be used for conversation.
`static void`	`setShareMenuItemsUpdateListener(ShareMenuItemsUpdateListener shareMenuItemsUpdateListenerLocal)`
`static void`	`setSpeechLocale(java.lang.String locale)`	Sets the locale used for speech connection.
`static oracle.cloud.bots.mobile.core.SpeechSynthesisSetting`	`setSpeechSynthesisVoicePreferences(java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting> speechSynthesisVoicePreferences)`	Deprecated. As of release 21.08, replaced by `setTTSVoice(ArrayList)`} and `getTTSVoice()`
`static void`	`setTTSService(SpeechSynthesisService ttsService)`
`static void`	`setTTSVoice(java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting> TTSVoices)`	Sets the voice preferences array which is used to choose the best match available voice for speech synthesis.
`static void`	`setUIEventListener(EventListener eventListener)`	Sets the listener for SDK UI to receive the response returned from the skill, message sent to the skill, to get updates on connection status change, and to receive an update when attachment upload is complete.
`static java.util.ArrayList<java.lang.Object>`	`shareMenuItems()`	The object of ShareMenuItems.
`static void`	`shareMenuItems(java.util.ArrayList<java.lang.Object> shareMenuItems)`	Updates the share menu item list.
`static void`	`shutdownBotAudioResponse()`	Releases the resources used by the SDK.
`static void`	`speakTTS(java.lang.String text)`	Starts reading the skill's response aloud.
`static void`	`speakTTS(Message message)`	Starts reading the skill's response aloud.
`static void`	`startAudioRecorder(IBotsSpeechListener iBotsSpeechListener)`	Starts only the audio recorder without performing speech recognition.
`static void`	`startBluetoothSco()`
`static void`	`startBotAudioResponse(java.lang.String text)`	Deprecated. As of release 21.08, replaced by `speakTTS(String)` ()}
`static void`	`startBotAudioResponse(Message message)`	Deprecated. As of release 21.08, replaced by `speakTTS(Message)`
`static void`	`startRecording(IBotsSpeechListener listener)`	Starts recording the user's voice message.
`static void`	`startSpeechRecognition(IBotsSpeechListener iBotsSpeechListener, boolean startAudioRecorderIfTurnedOff, int noSpeechTimeout, int maxSpeechTimeout)`	Starts speech recognition if the audio recorder is already turned on, else provide a feature to turn on audio recorder and perform speech recognition.
`static void`	`stopBluetoothSco()`
`static void`	`stopBotAudioResponse()`	Deprecated. As of release 21.08, replaced by `cancelTTS()`
`static void`	`stopRecording(boolean forceClose)`	Stops recording the user's voice message.
`static void`	`stopSpeechRecognition(boolean forceClose)`	Stops an ongoing speech recognition without changing the state of audio recorder
`static void`	`updateMessage(Message message)`	Updates the respective message in the database based on stored id.
`static void`	`updateUser(User profile)`	Updates the user profile information.
`static void`	`updateUser(org.json.JSONObject profile)`	Updates the user profile information using the parameter passed in the form of JSONObject.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Version
```
public static final java.lang.String Version
```
- Constructor Detail
  - Bots
```
public Bots()
```
- Method Detail
  - init
```
public static void init(@NonNull
                        android.app.Application application,
                        @NonNull
                        BotsConfiguration botsConfiguration)
                 throws BotsSDKException
```
    Initializes the SDK with the provided configuration.
    
    Parameters:
    
    application - The Application. This cannot be null.
    
    botsConfiguration - The BotsConfiguration object used to enable or disable SDK features. This cannot be null.
    
    Throws:
    
    BotsSDKException - An exception thrown when SDK initialization fails.
    
    See Also:
    
    BotsConfiguration, BotsConfiguration.BotsConfigurationBuilder, BotsSDKException
  - init
```
public static void init(@NonNull
                        android.app.Application application,
                        @NonNull
                        BotsConfiguration botsConfiguration,
                        @Nullable
                        BotsCallback botsCallback)
                 throws BotsSDKException
```
    Initializes the SDK with the provided configuration.
    
    Parameters:
    
    application - The Application. This cannot be null.
    
    botsConfiguration - The BotsConfiguration object used to enable or disable SDK features. This cannot be null.
    
    botsCallback - An optional BotsCallback instance to be notified of the result.
    
    Throws:
    
    BotsSDKException - An exception thrown when SDK initialization fails.
    
    See Also:
    
    BotsConfiguration, BotsConfiguration.BotsConfigurationBuilder, BotsCallback, BotsCallback.Response, BotsSDKException
  - init
```
public static void init(@NonNull
                        android.app.Application application,
                        java.lang.String url,
                        java.lang.String channelId,
                        java.lang.String userId,
                        @Nullable
                        BotsCallback botsCallback)
                 throws BotsSDKException
```
    Initializes the SDK with the default configuration.
    This can be called to establish a connection to channel with client authentication disabled.
    
    Parameters:
    
    application - The Application. This cannot be null.
    
    url - The URL of the Oracle Chat Server. This cannot be null.
    
    channelId - The Channel ID belonging to the Oracle Android channel. This cannot be null.
    
    userId - A unique identifier for the user. The SDK initializes this value when it's not provided.
    
    botsCallback - An optional BotsCallback instance to be notified of the result.
    
    Throws:
    
    BotsSDKException - An exception thrown when SDK initialization fails.
    
    See Also:
    
    BotsConfiguration, BotsConfiguration.BotsConfigurationBuilder, BotsCallback, BotsCallback.Response, BotsSDKException
  - init
```
public static void init(@NonNull
                        android.app.Application application,
                        java.lang.String url,
                        AuthenticationTokenProvider authTokenProvider,
                        @Nullable
                        BotsCallback botsCallback)
                 throws BotsSDKException
```
    Initializes the SDK with the default configuration.
    This can be called to establish a connection to channel with client authentication enabled.
    
    Parameters:
    
    application - The Application. This cannot be null.
    
    url - The URL of the Oracle Chat Server. This cannot be null.
    
    authTokenProvider - The instance of AuthenticationTokenProvider, which is used to generate the authentication token whenever it's needed.
    
    botsCallback - An optional BotsCallback instance to be notified of the result.
    
    Throws:
    
    BotsSDKException - An exception thrown when SDK initialization fails.
    
    See Also:
    
    AuthenticationTokenProvider, BotsConfiguration, BotsConfiguration.BotsConfigurationBuilder, BotsCallback, BotsCallback.Response, BotsSDKException
  - endChat
```
public static void endChat()
```
    Ends the current session of user.
  - clearConversationHistory
```
public static boolean clearConversationHistory()
```
    Clears the conversation history.
    
    Returns:
    
    true if the conversation history is cleared successfully, false otherwise
  - clearConversationHistory
```
public static void clearConversationHistory(ClearConversationCallback clearConversationCallback)
```
    Clears the conversation history.
    
    Parameters:
    
    clearConversationCallback - Callback triggered that notifies about the result of this API call.
    
    See Also:
    
    ClearConversationCallback
  - clearUnreadCount
```
public static boolean clearUnreadCount()
```
    Resets the count of the unread messages to 0
    
    Returns:
    
    true if the unread messages count is cleared, false otherwise
  - getAllConversations
```
public static java.util.List<Message> getAllConversations()
```
    Returns the list of the conversation messages.
    
    Returns:
    
    The list of conversation messages
    
    See Also:
    
    Message, MessagePayload
  - getBotsConfiguration
```
public static BotsConfiguration getBotsConfiguration()
```
    Returns the configuration object that's used to initialize the SDK with enabled features.
    
    Returns:
    
    The configuration object that's used to initialize the SDK with enabled features
    
    See Also:
    
    BotsConfiguration, BotsConfiguration.BotsConfigurationBuilder
  - getConnectionStatus
```
public static ConnectionStatus getConnectionStatus()
```
    Returns the current status of the WebSocket's connection to the skill.
    
    Returns:
    
    The connection status
    
    See Also:
    
    ConnectionStatus
  - getUnreadCount
```
public static int getUnreadCount()
```
    Returns the count of unread messages.
    Returns -1 if called before initializing the SDK.
    
    Returns:
    
    The count of unread messages
  - sendAttachment
```
public static void sendAttachment(FileWrapper attachment)
```
    Sends the uploaded attachment to the skill.
    
    Parameters:
    
    attachment - The attached file
    
    See Also:
    
    FileWrapper, MessagePayload, AttachmentMessagePayload
  - updateMessage
```
public static void updateMessage(Message message)
```
    Updates the respective message in the database based on stored id.
    
    Parameters:
    
    message - Message to be updated.
  - sendLocation
```
public static void sendLocation(Geolocation geoLocation)
```
    Sends the location coordinates to the skill.
    
    Parameters:
    
    geoLocation - The location coordinates
    
    See Also:
    
    Geolocation, MessagePayload, LocationMessagePayload
  - sendUserTypingStatus
```
public static void sendUserTypingStatus(TypingStatus status,
                                        java.lang.String text)
```
  - sendMessage
```
public static void sendMessage(java.lang.String text)
```
    Sends a text message to the skill.
    
    Parameters:
    
    text - The text message
    
    See Also:
    
    MessagePayload, TextMessagePayload
  - sendMessage
```
public static void sendMessage(java.lang.String text,
                               org.json.JSONObject metadata)
```
    Sends the text message and the metadata to the skill.
    
    Parameters:
    
    text - The text message
    
    metadata - The metadata object
    
    See Also:
    
    MessagePayload, TextMessagePayload
  - sendMessage
```
public static void sendMessage(MessagePayload messagePayload)
```
    Sends a message to the skill.
    
    Parameters:
    
    messagePayload - The message payload
    
    See Also:
    
    MessagePayload, TextMessagePayload, LocationMessagePayload, AttachmentMessagePayload, PostBackMessagePayload
  - sendPostBack
```
public static void sendPostBack(PostBackAction postBack)
```
    Sends the postback message to the skill.
    
    Parameters:
    
    postBack - The postback action message
    
    See Also:
    
    Action, PostBackAction
  - setUIEventListener
```
@RestrictTo(LIBRARY_GROUP)
public static void setUIEventListener(EventListener eventListener)
```
    Sets the listener for SDK UI to receive the response returned from the skill, message sent to the skill, to get updates on connection status change, and to receive an update when attachment upload is complete.
    Listens to the event notifications to update the SDK UI.
    
    Parameters:
    
    eventListener - An instance of type EventListener to receive updates
    
    See Also:
    
    EventListener
  - setEventListener
```
public static void setEventListener(EventListener eventListener)
```
    Sets the listener to receive the response returned from the skill, message sent to the skill, to get updates on connection status change, and to receive an update when attachment upload is complete.
    This is called before the SDK UI listener is notified of the conversation events.
    
    Parameters:
    
    eventListener - An instance of type EventListener to receive updates
    
    See Also:
    
    EventListener
  - startRecording
```
public static void startRecording(IBotsSpeechListener listener)
```
    Starts recording the user's voice message.
    
    Parameters:
    
    listener - An instance of IBotsSpeechListener to receive the response returned from the server
    
    See Also:
    
    IBotsSpeechListener, enableSpeechRecognition(boolean), isEnableSpeechRecognition(), stopRecording(boolean), isRecording(), setSpeechLocale(String), speechLocale(String), getSpeechLocale()
  - stopRecording
```
public static void stopRecording(boolean forceClose)
```
    Stops recording the user's voice message.
    
    Parameters:
    
    forceClose - Forcefully closes the speech websocket connection if set to true.
    
    See Also:
    
    enableSpeechRecognition(boolean), isEnableSpeechRecognition(), startRecording(IBotsSpeechListener), isRecording(), setSpeechLocale(String), speechLocale(String), getSpeechLocale()
  - startAudioRecorder
```
public static void startAudioRecorder(IBotsSpeechListener iBotsSpeechListener)
```
    Starts only the audio recorder without performing speech recognition.
    
    Parameters:
    
    iBotsSpeechListener - An instance of IBotsSpeechListener to receive the response returned from the server
    
    See Also:
    
    IBotsSpeechListener, stopRecording(boolean), isRecording()
  - startSpeechRecognition
```
public static void startSpeechRecognition(IBotsSpeechListener iBotsSpeechListener,
                                          boolean startAudioRecorderIfTurnedOff,
                                          int noSpeechTimeout,
                                          int maxSpeechTimeout)
```
    Starts speech recognition if the audio recorder is already turned on, else provide a feature to turn on audio recorder and perform speech recognition.
    
    Parameters:
    
    iBotsSpeechListener - An instance of IBotsSpeechListener to receive the response returned from the server
    
    startAudioRecorderIfTurnedOff - starts audio recorder if set as true
    
    noSpeechTimeout - Duration in milliseconds, the speech service will wait for some speech, after speech recognition has started, before ending speech recognition
    
    maxSpeechTimeout - Maximum duration, in milliseconds, of speech recognition. If the service detects continuous speech activity for this long, it will end speech recognition.
    
    See Also:
    
    IBotsSpeechListener, stopRecording(boolean), isRecording()
  - stopSpeechRecognition
```
public static void stopSpeechRecognition(boolean forceClose)
```
    Stops an ongoing speech recognition without changing the state of audio recorder
    
    Parameters:
    
    forceClose - Forcefully closes the speech websocket connection if set to true.
  - startBluetoothSco
```
public static void startBluetoothSco()
```
  - stopBluetoothSco
```
public static void stopBluetoothSco()
```
  - isRecording
```
public static boolean isRecording()
```
    Checks if the voice recording has started or not.
    
    Returns:
    
    true if the recording has started, false otherwise
    
    See Also:
    
    enableSpeechRecognition(boolean), isEnableSpeechRecognition(), startRecording(IBotsSpeechListener), stopRecording(boolean), setSpeechLocale(String), speechLocale(String), getSpeechLocale()
  - setSpeechLocale
```
public static void setSpeechLocale(java.lang.String locale)
```
    Sets the locale used for speech connection. The user is expected to speak with the same locale to the SDK.
    The locales currently supported are en-us, fr-fr, hi-in, es-es, pt-br, it-it, de-de, en-gb, en-in and en-au.
    
    Parameters:
    
    locale - The locale in which the user is expected to speak.
    
    See Also:
    
    enableSpeechRecognition(boolean), isEnableSpeechRecognition(), startRecording(IBotsSpeechListener), stopRecording(boolean), isRecording(), speechLocale(String), getSpeechLocale()
  - setShareMenuItemsUpdateListener
```
public static void setShareMenuItemsUpdateListener(ShareMenuItemsUpdateListener shareMenuItemsUpdateListenerLocal)
```
  - shareMenuItems
```
public static void shareMenuItems(java.util.ArrayList<java.lang.Object> shareMenuItems)
```
    Updates the share menu item list.
    
    Parameters:
    
    shareMenuItems - The share menu items list.
    
    See Also:
    
    ShareMenuCustomItem, ShareMenuItemUpdateListener
  - shareMenuItems
```
public static java.util.ArrayList<java.lang.Object> shareMenuItems()
```
    The object of ShareMenuItems.
    
    Returns:
    
    The current share menu items.
  - updateUser
```
public static void updateUser(org.json.JSONObject profile)
```
    Updates the user profile information using the parameter passed in the form of JSONObject.
    
    Parameters:
    
    profile - The user profile information
    
    See Also:
    
    User, updateUser(User)
  - updateUser
```
public static void updateUser(User profile)
```
    Updates the user profile information.
    
    Parameters:
    
    profile - The user profile information
    
    See Also:
    
    User, updateUser(JSONObject)
  - startBotAudioResponse
```
public static void startBotAudioResponse(java.lang.String text)
```
    Deprecated.
    As of release 21.08, replaced by speakTTS(String) ()}
    
    Starts reading the skill's response aloud.
    
    Parameters:
    
    text - The skill's message that's read aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - speakTTS
```
public static void speakTTS(java.lang.String text)
```
    Starts reading the skill's response aloud.
    
    Parameters:
    
    text - The skill's message that's read aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - startBotAudioResponse
```
public static void startBotAudioResponse(Message message)
```
    Deprecated.
    As of release 21.08, replaced by speakTTS(Message)
    
    Starts reading the skill's response aloud.
    
    Parameters:
    
    message - The skill's message that's read aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - speakTTS
```
public static void speakTTS(Message message)
```
    Starts reading the skill's response aloud.
    
    Parameters:
    
    message - The skill's message that's read aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - stopBotAudioResponse
```
public static void stopBotAudioResponse()
```
    Deprecated.
    As of release 21.08, replaced by cancelTTS()
    
    Stops reading the skill's response aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), speakTTS(String), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - cancelTTS
```
public static void cancelTTS()
```
    Stops reading the skill's response aloud.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), speakTTS(String), isSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - isTTSSpeaking
```
public static boolean isTTSSpeaking()
```
    Checks if the skill's response is currently being read aloud or not.
    
    Returns:
    
    true if the skill's response is currently being read aloud, false otherwise
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), speakTTS(String), cancelTTS(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - isSpeaking
```
public static boolean isSpeaking()
```
    Deprecated.
    As of release 21.08, replaced by isTTSSpeaking()
    
    Checks if the skill's response is currently being read aloud or not.
    
    Returns:
    
    true if the skill's response is currently being read aloud, false otherwise
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), speakTTS(String), cancelTTS(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - shutdownBotAudioResponse
```
public static void shutdownBotAudioResponse()
```
    Releases the resources used by the SDK.
    To be called in the onDestroy() method of Conversation Activity.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), initSpeechSynthesisService(), speakTTS(String), cancelTTS(), isTTSSpeaking(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - setTTSService
```
public static void setTTSService(SpeechSynthesisService ttsService)
```
  - initSpeechSynthesisService
```
public static void initSpeechSynthesisService()
```
    Initializes the speech synthesis service.
    To be called in the onCreate() method of Conversation Activity.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), speakTTS(String), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - setTTSVoice
```
public static void setTTSVoice(java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting> TTSVoices)
```
    Sets the voice preferences array which is used to choose the best match available voice for speech synthesis.
    If null or empty, the default settings or the speech recognition locale are used for speech synthesis.
    
    Parameters:
    
    TTSVoices - The voice preference array for speech synthesis.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), speakTTS(String), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - getTTSVoices
```
public static java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting> getTTSVoices()
```
    Returns list of all voices present in speech engine used to initialise Speech Synthesis Service object.
  - getTTSVoice
```
public static oracle.cloud.bots.mobile.core.SpeechSynthesisSetting getTTSVoice()
```
    Returns the voice that is used for speaking the utterances.
  - setSpeechSynthesisVoicePreferences
```
public static oracle.cloud.bots.mobile.core.SpeechSynthesisSetting setSpeechSynthesisVoicePreferences(java.util.ArrayList<oracle.cloud.bots.mobile.core.SpeechSynthesisSetting> speechSynthesisVoicePreferences)
```
    Deprecated.
    As of release 21.08, replaced by setTTSVoice(ArrayList)} and getTTSVoice()
    
    Sets the voice preferences array which is used to choose the best match available voice for speech synthesis.
    If null or empty, the default settings or the speech recognition locale are used for speech synthesis.
    
    Parameters:
    
    speechSynthesisVoicePreferences - The voice preference array for speech synthesis.
    
    Returns:
    
    The voice preference that is selected for speech synthesis.
    
    See Also:
    
    enableSpeechSynthesis(boolean), isEnableSpeechSynthesis(), speakTTS(String), cancelTTS(), isTTSSpeaking(), shutdownBotAudioResponse(), speechSynthesisVoicePreferences(ArrayList), getSpeechSynthesisVoicePreferences()
  - isInitialized
```
public static boolean isInitialized()
```
    Checks if the SDK has been initialized or not.
    
    Returns:
    
    true if the SDK has been initialized, false otherwise
    
    See Also:
    
    init(Application, BotsConfiguration), init(Application, BotsConfiguration, BotsCallback), init(Application, String, String, String, BotsCallback), init(Application, String, AuthenticationTokenProvider, BotsCallback)
  - destroy
```
public static void destroy()
```
    Terminates all the SDK facilities.
    SDK is automatically terminated when the application exits. This method does not, usually, have to be called manually.
  - connect
```
public static void connect(@NonNull
                           BotsConfiguration botsConfiguration)
                    throws BotsSDKException
```
    Reconnects the SDK with new BotsConfiguration
    
    Parameters:
    
    botsConfiguration - The BotsConfiguration object used to enable or disable SDK features. This cannot be null.
    
    Throws:
    
    BotsSDKException - An exception thrown when SDK initialization fails.
  - connect
```
public static void connect()
```
    Reconnects the SDK with previous BotsConfiguration.
  - disconnect
```
public static void disconnect()
```
    Disconnect the SDK
  - setPrimaryChatLanguage
```
public static void setPrimaryChatLanguage(java.lang.String languageTag)
```
    Sets the language tag to be used for conversation.
    
    Parameters:
    
    languageTag -
  - getMultiLangChatConfiguration
```
public static oracle.cloud.bots.mobile.core.internals.MultiLangChatConfiguration getMultiLangChatConfiguration()
```
  - getReconnectAttemptsExhausted
```
public static int getReconnectAttemptsExhausted()
```
    Returns the number of attempts exhausted for establishing connection.
  - getAgentDetails
```
public static AgentDetails getAgentDetails()
```
    Returns the current agent details for a particular agent session.
    
    Returns:
    
    An instance of type AgentDetails which has different attributes for agent details.
    
    See Also:
    
    AgentDetils
  - setAgentDetails
```
public static void setAgentDetails(AgentDetails agentDetails)
```
    Sets the agent details dynamically.
    
    Parameters:
    
    agentDetails - Object of type AgentDetails which contains attributes to set agent details.
    
    See Also:
    
    AgentDetails

Class Bots

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Version

Constructor Detail

Bots

Method Detail

init

init

init

init

endChat

clearConversationHistory

clearConversationHistory

clearUnreadCount

getAllConversations

getBotsConfiguration

getConnectionStatus

getUnreadCount

sendAttachment

updateMessage

sendLocation

sendUserTypingStatus

sendMessage

sendMessage

sendMessage

sendPostBack

setUIEventListener

setEventListener

startRecording

stopRecording

startAudioRecorder

startSpeechRecognition

stopSpeechRecognition

startBluetoothSco

stopBluetoothSco

isRecording

setSpeechLocale

setShareMenuItemsUpdateListener

shareMenuItems

shareMenuItems

updateUser

updateUser

startBotAudioResponse

speakTTS

startBotAudioResponse

speakTTS

stopBotAudioResponse

cancelTTS

isTTSSpeaking

isSpeaking

shutdownBotAudioResponse

setTTSService

initSpeechSynthesisService

setTTSVoice

getTTSVoices

getTTSVoice

setSpeechSynthesisVoicePreferences

isInitialized

destroy

connect

connect

disconnect

setPrimaryChatLanguage

getMultiLangChatConfiguration

getReconnectAttemptsExhausted

getAgentDetails

setAgentDetails