Conversation (Bots Client SDK 18.2.3 )

java.lang.Object
- oracle.cloud.mobile.core.Conversation

```
public class Conversation
extends java.lang.Object
```
The Conversation provides an interface to interact with the current user's conversation.
To obtain an instance, use Bots.getConversation(). Bots.init(Application, Settings, BotsCallback) must have been called prior to retrieving the conversation object.
To send a message, use sendMessage(Message) with a Message object. Example: Bots.getConversation().sendMessage(new Message("Hello World!"));

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Conversation.Delegate` Delegate for events related to the conversation.
`static interface`	`Conversation.MessageModifierDelegate` Delegate for events related to sending and displaying of specific messages.
`static interface`	`Conversation.ViewDelegate` Delegate for events related to the conversation view.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessage(Message message)` Adds a new message to the conversation without sending it.
`void`	`botsHidden()` Notifies the delegate when Bots Conversation is hidden
`void`	`botsShown()` Notifies the delegate when Bots Conversation is shown
`java.util.Date`	`getAppMakerLastRead()` Date when the business last read the user messages
`Conversation.Delegate`	`getDelegate()` The delegate set via `setDelegate(Delegate)`.
`Conversation.MessageModifierDelegate`	`getMessageModifierDelegate()` The delegate set via `setMessageModifierDelegate(MessageModifierDelegate)`.
`java.util.List<Message>`	`getMessages()` The list of Message objects representing the conversation.
`int`	`getUnreadCount()` Count of unread messages in the conversation.
`Conversation.ViewDelegate`	`getViewDelegate()` The delegate set via `setViewDelegate(ViewDelegate)`
`boolean`	`isBotsShown()` Returns `true` if the Bots UI is currently shown
`void`	`loadCardSummary()` Loads billing info (if exists) to display last4 in credit form.
`void`	`markAllAsRead()` Marks all unread messages as read.
`void`	`markAsRead(Message message)` Marks an unread message as read.
`void`	`postback(MessageAction action, BotsCallback callback)` Triggers MessageAction postback.
`void`	`processPayment(CreditCard creditCard, MessageAction action)` Processes a credit card payment.
`void`	`removeMessage(Message message)` Removes a failed or unsent message from the conversation.
`Message`	`retryMessage(Message message)` Retries a message that failed to send.
`void`	`sendMessage(Message message)` Adds a new message to the conversation.
`void`	`setBotsUIDelegate(Conversation.Delegate botsUIDelegate)` Sets the `Conversation.Delegate` used by the bots-ui package
`void`	`setDelegate(Conversation.Delegate delegate)` Sets the `Conversation.Delegate`
`void`	`setMessageModifierDelegate(Conversation.MessageModifierDelegate messageModifierDelegate)` Sets the `Conversation.MessageModifierDelegate`
`void`	`setViewDelegate(Conversation.ViewDelegate viewDelegate)` Sets the `Conversation.ViewDelegate`
`void`	`startTyping()` Notify the server that the user is typing.
`void`	`stopTyping()` Notify the server that the user has finished typing.
`void`	`triggerAction(MessageAction action)` Triggers message action resulting from a click.
`void`	`uploadFile(Message fileMessage, BotsCallback callback)` /** Uploads a user file to the conversation.
`void`	`uploadImage(Message imageMessage, BotsCallback callback)` Uploads a user image to the conversation.

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

- Method Detail
  - setDelegate
```
public void setDelegate(Conversation.Delegate delegate)
```
    Sets the Conversation.Delegate
    This delegate will be notified before the delegate set using setBotsUIDelegate(Delegate)
    Any delegate functions with the form boolean return type will prevent notification of botsUIDelegate
    See setBotsUIDelegate(Delegate)
    
    Parameters:
    
    delegate - The delegate
  - setBotsUIDelegate
```
public void setBotsUIDelegate(Conversation.Delegate botsUIDelegate)
```
    Sets the Conversation.Delegate used by the bots-ui package
    The primary use of this property is to notify the Bots UI of changes in the Conversation
    Note that this delegate will be notified after the delegate set using setDelegate(Delegate)
    See setDelegate(Delegate)
    
    Parameters:
    
    botsUIDelegate - The botsUIDelegate
  - setMessageModifierDelegate
```
public void setMessageModifierDelegate(Conversation.MessageModifierDelegate messageModifierDelegate)
```
    Sets the Conversation.MessageModifierDelegate
    The delegate allows you to change the way messages are displayed or sent to Bots.
    
    Parameters:
    
    messageModifierDelegate - The messageModifierDelegate
  - setViewDelegate
```
public void setViewDelegate(Conversation.ViewDelegate viewDelegate)
```
    Sets the Conversation.ViewDelegate
    The delegate allows you to be notified of events related to the conversation view
    
    Parameters:
    
    viewDelegate - The viewDelegate
  - getDelegate
```
public Conversation.Delegate getDelegate()
```
    The delegate set via setDelegate(Delegate).
    
    Returns:
    
    The delegate
  - getMessageModifierDelegate
```
public Conversation.MessageModifierDelegate getMessageModifierDelegate()
```
    The delegate set via setMessageModifierDelegate(MessageModifierDelegate).
    
    Returns:
    
    The messageModifierDelegate
  - getViewDelegate
```
public Conversation.ViewDelegate getViewDelegate()
```
    The delegate set via setViewDelegate(ViewDelegate)
    
    Returns:
    
    The ViewDelegate instance
  - getMessages
```
public java.util.List<Message> getMessages()
```
    The list of Message objects representing the conversation.
    
    Returns:
    
    Unmodifiable list of Message objects
  - getUnreadCount
```
public int getUnreadCount()
```
    Count of unread messages in the conversation.
    The primary use of this property is to be able to display an indicator when the conversation has unread messages.
    
    Returns:
    
    The unread message count
  - getAppMakerLastRead
```
public java.util.Date getAppMakerLastRead()
```
    Date when the business last read the user messages
    
    Returns:
    
    date when the business last read the user messages
  - markAllAsRead
```
public void markAllAsRead()
```
    Marks all unread messages as read.
    Marks all unread messages as read, and notifies that the unread count changed.
  - markAsRead
```
public void markAsRead(Message message)
```
    Marks an unread message as read.
    Marks an unread message as read, and notifies that the unread count changed.
  - sendMessage
```
public void sendMessage(Message message)
```
    Adds a new message to the conversation.
    For each message added using sendMessage, a notification will be fired indicating the success or failure status of the upload.
    
    Parameters:
    
    message - The message to send
  - retryMessage
```
public Message retryMessage(Message message)
```
    Retries a message that failed to send.
    The failed message will be removed from the message list, and a new message will be constructed with the same text as the failed message. A notification will be fired indicating the success or failure status of the upload.
    
    Parameters:
    
    message - The failed message
    
    Returns:
    
    The sent message
  - addMessage
```
public void addMessage(Message message)
```
    Adds a new message to the conversation without sending it.
    
    Parameters:
    
    message - The message to add
  - removeMessage
```
public void removeMessage(Message message)
```
    Removes a failed or unsent message from the conversation.
    
    Parameters:
    
    message - The message to remove
  - uploadImage
```
public void uploadImage(Message imageMessage,
                        BotsCallback callback)
```
    Uploads a user image to the conversation.
    For each image upload, provided BotsCallback will be called with status code, error and the resulting message
    
    Parameters:
    
    imageMessage - The imageMessage to upload
    
    callback - The callback, to be called with BotsCallback.Response getData() of type Message, null in case of error
    
    See Also:
    
    Message, BotsCallback
  - uploadFile
```
public void uploadFile(Message fileMessage,
                       BotsCallback callback)
```
    /** Uploads a user file to the conversation.
    For each file upload, provided BotsCallback will be called with status code, error and the resulting message
    
    Parameters:
    
    fileMessage - The fileMessage to upload
    
    callback - The callback, to be called with BotsCallback.Response getData() of type Message, null in case of error
    
    See Also:
    
    Message, BotsCallback
  - startTyping
```
public void startTyping()
```
    Notify the server that the user is typing. This method is called automatically when using the default ConversationFragment. Only call this method if your application implements its own conversation view.
    Typing updates are automatically throttled, so you may call this method as often as necessary. The typing stop event will automatically fire 10 seconds after the most recent call to this method.
    
    See Also:
    
    stopTyping()
  - stopTyping
```
public void stopTyping()
```
    Notify the server that the user has finished typing. This method is called automatically when using the default ConversationFragment. Only call this method if your application implements its own conversation view.
    If the user was not flagged as typing recently, this method will result in a no-op.
    
    See Also:
    
    startTyping()
  - processPayment
```
public void processPayment(CreditCard creditCard,
                           MessageAction action)
```
    Processes a credit card payment.
    
    Parameters:
    
    creditCard - The credit card object
    
    action - The message action
    
    See Also:
    
    CreditCard, MessageAction
  - triggerAction
```
public void triggerAction(MessageAction action)
```
    Triggers message action resulting from a click.
    
    Parameters:
    
    action - The message action
    
    See Also:
    
    MessageAction
  - loadCardSummary
```
public void loadCardSummary()
```
    Loads billing info (if exists) to display last4 in credit form.
  - postback
```
public void postback(MessageAction action,
                     BotsCallback callback)
```
    Triggers MessageAction postback.
    
    See Also:
    
    MessageAction, BotsCallback
  - botsShown
```
public void botsShown()
```
    Notifies the delegate when Bots Conversation is shown
    Used by the bots-ui package to notify the Conversation.Delegate when Bots is shown
  - botsHidden
```
public void botsHidden()
```
    Notifies the delegate when Bots Conversation is hidden
    Used by the bots-ui package to notify the Conversation.Delegate when Bots is hidden
  - isBotsShown
```
public boolean isBotsShown()
```
    Returns true if the Bots UI is currently shown
    
    Returns:
    
    true if the Bots UI is currently shown, false otherwise

Class Conversation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setDelegate

setBotsUIDelegate

setMessageModifierDelegate

setViewDelegate

getDelegate

getMessageModifierDelegate

getViewDelegate

getMessages

getUnreadCount

getAppMakerLastRead

markAllAsRead

markAsRead

sendMessage

retryMessage

addMessage

removeMessage

uploadImage

uploadFile

startTyping

stopTyping

processPayment

triggerAction

loadCardSummary

postback

botsShown

botsHidden

isBotsShown