com.quickblox.chat

Interface QBChat<C extends QBChat>

public interface QBChat<C extends QBChat>

The interface for the real time chat.

Use its concrete subclasses: QBPrivateChat and QBGroupChat.

Method Summary

Modifier and Type	Method and Description
void	addIsTypingListener(QBIsTypingListener<C> listener) Adds the 'is typing' listener.
void	addMessageListener(QBMessageListener<C> listener) Adds the incoming messages listener.
void	deliverMessage(QBChatMessage message) Delivers the message.
void	deliverMessage(QBChatMessage message, QBEntityCallback<java.lang.Void> callback) Delivers the message async.
java.lang.String	getDialogId() Returns dialog id of the chat
java.util.Collection<QBIsTypingListener<C>>	getIsTypingListeners() Gets the list of 'is typing' listeners
java.util.Collection<QBMessageListener<C>>	getMessageListeners() Gets the list of message listeners.
void	readMessage(QBChatMessage message) Reads the message.
void	readMessage(QBChatMessage message, QBEntityCallback<java.lang.Void> callback) Reads the message async.
void	removeIsTypingListener(QBIsTypingListener<C> listener) Removes the 'is typing' listener.
void	removeMessageListener(QBMessageListener<C> listener) Removes the incoming messages listener.
void	sendIsTypingNotification() Sends 'is typing' notification.
void	sendIsTypingNotification(QBEntityCallback<java.lang.Void> callback) Sends 'is typing' notification async.
void	sendMessage(QBChatMessage message) Sends a chat message to chat.
void	sendMessage(QBChatMessage message, QBEntityCallback<java.lang.Void> callback) Sends a chat message to chat async.
void	sendMessage(java.lang.String text) Sends a chat message to chat.
void	sendMessage(java.lang.String text, QBEntityCallback<java.lang.Void> callback) Sends a chat message to chat async.
void	sendStopTypingNotification() Sends 'stop typing' notification.
void	sendStopTypingNotification(QBEntityCallback<java.lang.Void> callback) Sends 'stop typing' notification async.

Method Detail

getDialogId

java.lang.String getDialogId()

Returns dialog id of the chat

sendMessage

void sendMessage(java.lang.String text)
          throws SmackException.NotConnectedException

Sends a chat message to chat.

Parameters:

text - The text of the message to send.

Throws:

SmackException.NotConnectedException

sendMessage

void sendMessage(java.lang.String text,
                 QBEntityCallback<java.lang.Void> callback)

Sends a chat message to chat async.

Parameters:

text - The text of the message to send.

callback - A generic object for callback, must implement QBEntityCallback interface.

sendMessage

void sendMessage(QBChatMessage message)
          throws SmackException.NotConnectedException

Sends a chat message to chat.

Parameters:

message - The message to send.

Throws:

SmackException.NotConnectedException

See Also:

QBChatMessage

sendMessage

void sendMessage(QBChatMessage message,
                 QBEntityCallback<java.lang.Void> callback)

Sends a chat message to chat async.

Parameters:

message - The message to send.

callback - A generic object for callback, must implement QBEntityCallback interface.

addMessageListener

void addMessageListener(QBMessageListener<C> listener)

Adds the incoming messages listener.

Parameters:

listener - The listener to set.

See Also:

QBMessageListener

removeMessageListener

void removeMessageListener(QBMessageListener<C> listener)

Removes the incoming messages listener.

Parameters:

listener - The listener to remove.

See Also:

QBMessageListener

getMessageListeners

java.util.Collection<QBMessageListener<C>> getMessageListeners()

Gets the list of message listeners.

See Also:

QBMessageListener

sendIsTypingNotification

void sendIsTypingNotification()
                       throws XMPPException,
                              SmackException.NotConnectedException

Sends 'is typing' notification.

Throws:

XMPPException

SmackException.NotConnectedException

sendIsTypingNotification

void sendIsTypingNotification(QBEntityCallback<java.lang.Void> callback)

Sends 'is typing' notification async.

Parameters:

callback - A generic object for callback, must implement QBEntityCallback interface.

sendStopTypingNotification

void sendStopTypingNotification()
                         throws XMPPException,
                                SmackException.NotConnectedException

Sends 'stop typing' notification.

Throws:

XMPPException

SmackException.NotConnectedException

sendStopTypingNotification

void sendStopTypingNotification(QBEntityCallback<java.lang.Void> callback)

Sends 'stop typing' notification async.

Parameters:

callback - A generic object for callback, must implement QBEntityCallback interface.

addIsTypingListener

void addIsTypingListener(QBIsTypingListener<C> listener)

Adds the 'is typing' listener.

Parameters:

listener - The listener to set.

See Also:

QBIsTypingListener

removeIsTypingListener

void removeIsTypingListener(QBIsTypingListener<C> listener)

Removes the 'is typing' listener.

Parameters:

listener - The listener to remove.

See Also:

QBIsTypingListener

getIsTypingListeners

java.util.Collection<QBIsTypingListener<C>> getIsTypingListeners()

Gets the list of 'is typing' listeners

See Also:

QBIsTypingListener

readMessage

void readMessage(QBChatMessage message)
          throws XMPPException,
                 SmackException.NotConnectedException

Reads the message.

Parameters:

message - The origin message

Throws:

XMPPException

SmackException.NotConnectedException

readMessage

void readMessage(QBChatMessage message,
                 QBEntityCallback<java.lang.Void> callback)

Reads the message async.

Parameters:

message - The origin message

callback - A generic object for callback, must implement QBEntityCallback interface.

deliverMessage

void deliverMessage(QBChatMessage message)
             throws XMPPException,
                    SmackException.NotConnectedException

Delivers the message.

Parameters:

message - The origin message

Throws:

XMPPException

SmackException.NotConnectedException

deliverMessage

void deliverMessage(QBChatMessage message,
                    QBEntityCallback<java.lang.Void> callback)

Delivers the message async.

Parameters:

message - The origin message

callback - A generic object for callback, must implement QBEntityCallback interface.