io.supportkit.core

Class Conversation

java.lang.Object

io.supportkit.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 SupportKit.getConversation(). SupportKit.init(Application, Settings) must have been called prior to retrieving the conversation object.

To send a message, use sendMessage(Message) with a Message object. Example: SupportKit.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.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<Message>	getMessages() The list of Message objects representing the conversation.
int	getUnreadCount() Count of unread messages in the conversation.
void	markAllAsRead() Marks all unread messages as read.
void	markAsRead(Message message) Marks an unread message as read.
Message	retryMessage(Message message) Retries a message that failed to send.
void	sendMessage(Message message) Adds a new message to the conversation.
void	setDelegate(Conversation.Delegate delegate) A delegate object for receiving notifications related 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)

A delegate object for receiving notifications related to the conversation.

Parameters:

delegate - The delegate

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

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.

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

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