com.quickblox.chat.model

Class QBChatDialog

java.lang.Object

com.quickblox.core.model.QBEntity

com.quickblox.chat.model.QBChatDialog

All Implemented Interfaces:

java.io.Serializable

public class QBChatDialog
extends QBEntity

QBChatDialog model describes a chat dialog entity between users (1-1 chat or group chat).

QBChatDialog is responsible for all chat related operations - send/receive messages, join, typing statuses etc.

Use DialogUtils for simple building QBChatDialog.

To listen for messages, typing notifications or "sent" status of your message just add appropriate listeners: addIsTypingListener(QBChatDialogTypingListener), addMessageListener(QBChatDialogMessageListener), addMessageSentListener(QBChatDialogMessageSentListener).

To listen for "delivered" or "read" statuses of your message use QBMessageStatusesManager. To handle these statuses you should mark sending message as markable QBChatMessage.setMarkable(boolean)

To notify opponent you've read message use readMessage(com.quickblox.chat.model.QBChatMessage) method.

Using of QBChatDialog:

 ArrayList occupantIdsList = ...;

 QBChatDialog dialog = new QBChatDialog();
 dialog.setName("Chat with Garry and John");
 dialog.setPhoto("1786");
 dialog.setType(QBDialogType.GROUP);
 dialog.setOccupantsIds(occupantIdsList);

 //creating chat dialog on server
 QBRestChatService.createChatDialog(dialog).performAsync(
      new QBEntityCallback() {
      @Override
      public void onSuccess(QBChatDialog resultChatDialog, Bundle params) {
          //dialog was created successfully
          resultChatDialog.join(null);

          ...
          resultChatDialog.sendMessage("Hello All");
      }

      @Override
      public void onError(QBResponseException responseException) {

      }
      });
 

Since:

3.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.quickblox.core.model.QBEntity

createdAt, id, updatedAt

Constructor Summary

Constructors

Constructor and Description
QBChatDialog() Constructs a new QBDialog object
QBChatDialog(java.lang.String id) Constructs a new QBDialog object with ID

Method Summary

Modifier and Type	Method and Description
void	addIsTypingListener(QBChatDialogTypingListener listener) Adds the 'is typing' listener.
void	addMessageListener(QBChatDialogMessageListener listener) Adds the incoming messages listener.
void	addMessageSentListener(QBChatDialogMessageSentListener listener) Adds the 'message sent' listener.
void	addParticipantListener(QBChatDialogParticipantListener participantListener) Adds a listener that will be notified of any new Presence packets sent to the group chat.
void	deliverMessage(QBChatMessage message) Delivers the message.
void	deliverMessage(QBChatMessage message, QBEntityCallback callback)
boolean	equals(java.lang.Object o)
QBDialogCustomData	getCustomData() Gets the custom data.
java.lang.String	getDialogId() Gets the dialog's ID
java.util.Collection<QBChatDialogTypingListener>	getIsTypingListeners() Gets the list of 'is typing' listeners
java.lang.String	getLastMessage() Gets the last sent message
long	getLastMessageDateSent() Gets the last message date sent
java.lang.Integer	getLastMessageUserId() Gets the last sent message user ID
java.util.Collection<QBChatDialogMessageListener>	getMessageListeners() Gets the list of message listeners.
java.util.Collection<QBChatDialogMessageSentListener>	getMessageSentListeners() Gets the list of 'message sent' listeners For using QBChatDialogMessageSentListener's features need enable Stream Management before logging into the chat.
java.lang.String	getName() Gets the name
java.util.List<java.lang.Integer>	getOccupants() Gets the occupants IDs array
java.util.Collection<java.lang.Integer>	getOnlineUsers() Deprecated. since 3.3.3, see requestOnlineUsers()
java.util.Collection<QBChatDialogParticipantListener>	getParticipantListeners() Gets the list of participant listeners.
java.lang.String	getPhoto() Gets the photo.
java.lang.Integer	getRecipientId() Returns the ID of a recipient if type = QBDialogType.PRIVATE. -1 otherwise.
java.lang.String	getRoomJid() Gets the XMPP room JID.
QBDialogType	getType() Gets the type
java.lang.Integer	getUnreadMessageCount() Gets the unread message count in this dialog
java.lang.Integer	getUserId() Gets the creator's ID of a dialog
int	hashCode()
void	initForChat(QBChatService chatService) Initializing current dialog for using chat functions.
void	initForChat(java.lang.String dialogId, QBDialogType type, QBChatService chatService) Initializing current dialog for using chat functions.
boolean	isJoined() Returns true if the user currently is in the group chat (after calling the join method).
boolean	isPrivate()
void	join(DiscussionHistory discussionHistory) Joins the group chat (synchronous).
void	join(DiscussionHistory discussionHistory, QBEntityCallback callback) Joins the group chat.
void	leave() Leaves the group chat.
void	readMessage(QBChatMessage message) Reads the message.
void	readMessage(QBChatMessage message, QBEntityCallback callback)
void	removeIsTypingListener(QBChatDialogTypingListener listener) Removes the 'is typing' listener.
void	removeMessageListrener(QBChatDialogMessageListener listener) Removes the incoming messages listener.
void	removeMessageSentListener(QBChatDialogMessageSentListener listener) Removes the 'message sent' listener.
void	removeParticipantListener(QBChatDialogParticipantListener participantListener) Removes a packet listener that was being notified of any new Presence packets sent to the group chat.
java.util.Collection<java.lang.Integer>	requestOnlineUsers() Returns a collection of online users IDs in the group chat.
void	sendIsTypingNotification() Sends 'is typing' notification.
void	sendIsTypingNotification(QBEntityCallback<java.lang.Void> callback)
void	sendMessage(QBChatMessage message) Sends a chat message to the chat.
void	sendMessage(QBChatMessage message, QBEntityCallback<java.lang.Void> callback)
void	sendMessage(java.lang.String text) Sends a chat message to the chat.
void	sendMessageWithoutJoin(QBChatMessage message) Sends a chat message to the group chat without join it before
void	sendMessageWithoutJoin(QBChatMessage message, QBEntityCallback<java.lang.Void> callback)
void	sendPresence(java.util.Map<java.lang.String,java.lang.String> extendedParameters) Sends the presence with custom parameters to the group chat.
void	sendStopTypingNotification() Sends 'stop typing' notification.
void	sendStopTypingNotification(QBEntityCallback<java.lang.Void> callback)
void	setCustomData(QBDialogCustomData customData) Sets the custom data.
void	setDialogId(java.lang.String dialogId) Sets the dialog's ID
void	setLastMessage(java.lang.String lastMessage) Sets the last sent message
void	setLastMessageDateSent(long lastMessageDateSent) Sets the last message date sent
void	setLastMessageUserId(java.lang.Integer lastMessageUserId) Sets the last sent message user ID
void	setName(java.lang.String name) Sets the name
void	setOccupantsIds(java.util.List<java.lang.Integer> occupantsIds) Sets the occupants IDs
void	setPhoto(java.lang.String photo) Sets the photo.
void	setRoomJid(java.lang.String roomJid) Sets the XMPP room JID.
void	setType(QBDialogType type) Sets the type
void	setUnreadMessageCount(java.lang.Integer unreadMessageCount) Sets the unread message count in this dialog
void	setUserId(java.lang.Integer userId) Sets the creator's ID of a dialog
java.lang.String	toString()

Methods inherited from class com.quickblox.core.model.QBEntity

copyFieldsTo, getCreatedAt, getFCreatedAt, getFUpdatedAt, getId, getUpdatedAt, setCreatedAt, setId, setUpdatedAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QBChatDialog

public QBChatDialog()

Constructs a new QBDialog object

QBChatDialog

public QBChatDialog(java.lang.String id)

Constructs a new QBDialog object with ID

Parameters:

id - ID of a dialog

Method Detail

getDialogId

public java.lang.String getDialogId()

Gets the dialog's ID

setDialogId

public void setDialogId(java.lang.String dialogId)

Sets the dialog's ID

Parameters:

dialogId - the ID to set

getName

public java.lang.String getName()

Gets the name

setName

public void setName(java.lang.String name)

Sets the name

Parameters:

name - The name to set

getType

public QBDialogType getType()

Gets the type

See Also:

QBDialogType

setType

public void setType(QBDialogType type)

Sets the type

Parameters:

type - The type to set

See Also:

QBDialogType

getUserId

public java.lang.Integer getUserId()

Gets the creator's ID of a dialog

setUserId

public void setUserId(java.lang.Integer userId)

Sets the creator's ID of a dialog

Parameters:

userId - The creator's ID to set

getOccupants

public java.util.List<java.lang.Integer> getOccupants()

Gets the occupants IDs array

setOccupantsIds

public void setOccupantsIds(java.util.List<java.lang.Integer> occupantsIds)

Sets the occupants IDs

Parameters:

occupantsIds - An array of occupants IDs to set

getLastMessage

public java.lang.String getLastMessage()

Gets the last sent message

setLastMessage

public void setLastMessage(java.lang.String lastMessage)

Sets the last sent message

Parameters:

lastMessage - The last sent message

getLastMessageUserId

public java.lang.Integer getLastMessageUserId()

Gets the last sent message user ID

setLastMessageUserId

public void setLastMessageUserId(java.lang.Integer lastMessageUserId)

Sets the last sent message user ID

Parameters:

lastMessageUserId - The last sent message user ID

getLastMessageDateSent

public long getLastMessageDateSent()

Gets the last message date sent

setLastMessageDateSent

public void setLastMessageDateSent(long lastMessageDateSent)

Sets the last message date sent

Parameters:

lastMessageDateSent - The last message date sent to set

getUnreadMessageCount

public java.lang.Integer getUnreadMessageCount()

Gets the unread message count in this dialog

setUnreadMessageCount

public void setUnreadMessageCount(java.lang.Integer unreadMessageCount)

Sets the unread message count in this dialog

Parameters:

unreadMessageCount - The unread message count to set

getRoomJid

public java.lang.String getRoomJid()

Gets the XMPP room JID. This is used to join a real time group chat.

setRoomJid

public void setRoomJid(java.lang.String roomJid)

Sets the XMPP room JID.

Parameters:

roomJid - The XMPP room JID.

getPhoto

public java.lang.String getPhoto()

Gets the photo. It can be a web link or an ID of some object.

setPhoto

public void setPhoto(java.lang.String photo)

Sets the photo. It can be a web link or an ID of some object.

Parameters:

photo - The photo to set

getCustomData

public QBDialogCustomData getCustomData()

Gets the custom data.

setCustomData

public void setCustomData(QBDialogCustomData customData)

Sets the custom data.

Parameters:

customData - The data object to set

getRecipientId

public java.lang.Integer getRecipientId()

Returns the ID of a recipient if type = QBDialogType.PRIVATE. -1 otherwise.

initForChat

public void initForChat(QBChatService chatService)

Initializing current dialog for using chat functions.

Current dialog's field "_id" can't be empty of null. Current dialog's type can't be null.

Parameters:

chatService - Instance of QBChatService for initializing chat functions.

Since:

3.0

initForChat

public void initForChat(java.lang.String dialogId,
                        QBDialogType type,
                        QBChatService chatService)

Initializing current dialog for using chat functions.

Parameters:

dialogId - The current dialog's Id. Can't be empty of null.

type - The type of current dialog. Can't be null.

chatService - Instance of QBChatService for initializing chat functions.

Throws:

java.lang.IllegalArgumentException

Since:

3.0

sendMessage

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

Sends a chat message to the chat.

Parameters:

text - The text of the message to send.

Throws:

SmackException.NotConnectedException

Since:

3.0

sendMessage

public void sendMessage(QBChatMessage message)
                 throws SmackException.NotConnectedException

Sends a chat message to the chat.

Parameters:

message - The message to send.

Throws:

SmackException.NotConnectedException

Since:

3.0

sendMessage

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

addMessageListener

public void addMessageListener(QBChatDialogMessageListener listener)

Adds the incoming messages listener.

Parameters:

listener - The listener to set.

Since:

3.0

See Also:

QBChatDialogMessageListener

removeMessageListrener

public void removeMessageListrener(QBChatDialogMessageListener listener)

Removes the incoming messages listener.

Parameters:

listener - The listener to remove.

Since:

3.0

See Also:

QBChatDialogMessageListener

getMessageListeners

public java.util.Collection<QBChatDialogMessageListener> getMessageListeners()

Gets the list of message listeners.

Since:

3.0

See Also:

QBChatDialogMessageListener

sendIsTypingNotification

public void sendIsTypingNotification()
                              throws XMPPException,
                                     SmackException.NotConnectedException

Sends 'is typing' notification.

Throws:

SmackException.NotConnectedException

XMPPException

Since:

3.0

sendIsTypingNotification

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

sendStopTypingNotification

public void sendStopTypingNotification()
                                throws XMPPException,
                                       SmackException.NotConnectedException

Sends 'stop typing' notification.

Throws:

XMPPException

SmackException.NotConnectedException

Since:

3.0

sendStopTypingNotification

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

addIsTypingListener

public void addIsTypingListener(QBChatDialogTypingListener listener)

Adds the 'is typing' listener.

Parameters:

listener - The listener to set.

Since:

3.0

See Also:

QBChatDialogTypingListener

removeIsTypingListener

public void removeIsTypingListener(QBChatDialogTypingListener listener)

Removes the 'is typing' listener.

Parameters:

listener - The listener to remove.

Since:

3.0

See Also:

QBChatDialogTypingListener

getIsTypingListeners

public java.util.Collection<QBChatDialogTypingListener> getIsTypingListeners()

Gets the list of 'is typing' listeners

Since:

3.0

See Also:

QBChatDialogTypingListener

addMessageSentListener

public void addMessageSentListener(QBChatDialogMessageSentListener listener)

Adds the 'message sent' listener.

For using QBChatDialogMessageSentListener's features need enable Stream Management before logging into the chat.

Parameters:

listener - The listener to set.

Since:

3.0

See Also:

QBChatService.setUseStreamManagement(boolean), QBChatDialogMessageSentListener

removeMessageSentListener

public void removeMessageSentListener(QBChatDialogMessageSentListener listener)

Removes the 'message sent' listener.

For using QBChatDialogMessageSentListener's features need enable Stream Management before logging into the chat.

Parameters:

listener - The listener to remove.

Since:

3.0

See Also:

QBChatService.setUseStreamManagement(boolean), QBChatDialogMessageSentListener

getMessageSentListeners

public java.util.Collection<QBChatDialogMessageSentListener> getMessageSentListeners()

Gets the list of 'message sent' listeners

For using QBChatDialogMessageSentListener's features need enable Stream Management before logging into the chat.

Since:

3.0

See Also:

QBChatService.setUseStreamManagement(boolean), QBChatDialogMessageSentListener

readMessage

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

Reads the message.

Parameters:

message - The origin message

Throws:

XMPPException

SmackException.NotConnectedException

Since:

3.0

readMessage

public void readMessage(QBChatMessage message,
                        QBEntityCallback callback)

deliverMessage

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

Delivers the message.

Parameters:

message - The origin message

Throws:

XMPPException

SmackException.NotConnectedException

Since:

3.0

deliverMessage

public void deliverMessage(QBChatMessage message,
                           QBEntityCallback callback)

isPrivate

public boolean isPrivate()

Returns:

true if current dialog's type is QBDialogType.PRIVATE or false otherwise.

Since:

3.0

See Also:

QBDialogType

isJoined

public boolean isJoined()

Returns true if the user currently is in the group chat (after calling the join method).

Since:

3.0

join

public void join(DiscussionHistory discussionHistory,
                 QBEntityCallback callback)

Joins the group chat.

Parameters:

discussionHistory - history config which controls the number of characters or messages to receive when entering a room. The room will decide the amount of history to return if you don't specify a DiscussionHistory while joining a room.

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

Since:

3.0

join

public void join(DiscussionHistory discussionHistory)
          throws XMPPException,
                 SmackException

Joins the group chat (synchronous).

Parameters:

discussionHistory - history config which controls the number of characters or messages to receive when entering a room. The room will decide the amount of history to return if you don't specify a DiscussionHistory while joining a room.

Throws:

XMPPException.XMPPErrorException

SmackException

XMPPException

Since:

3.0

leave

public void leave()
           throws XMPPException,
                  SmackException.NotConnectedException

Leaves the group chat.

Throws:

XMPPException

SmackException.NotConnectedException

Since:

3.0

sendMessageWithoutJoin

public void sendMessageWithoutJoin(QBChatMessage message)
                            throws SmackException.NotConnectedException

Sends a chat message to the group chat without join it before

Parameters:

message - The message to send.

Throws:

SmackException.NotConnectedException

Since:

3.0

sendMessageWithoutJoin

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

addParticipantListener

public void addParticipantListener(QBChatDialogParticipantListener participantListener)

Adds a listener that will be notified of any new Presence packets sent to the group chat. Using a listener is a suitable way to know when the list of occupants should be re-loaded due to any changes.

Parameters:

participantListener - A listener that will be notified of any presence packets sent to the group chat.

Since:

3.0

See Also:

QBChatDialogParticipantListener

removeParticipantListener

public void removeParticipantListener(QBChatDialogParticipantListener participantListener)

Removes a packet listener that was being notified of any new Presence packets sent to the group chat.

Parameters:

participantListener - - A QBChatDialogParticipantListener instance

Since:

3.0

See Also:

QBChatDialogParticipantListener

getParticipantListeners

public java.util.Collection<QBChatDialogParticipantListener> getParticipantListeners()

Gets the list of participant listeners.

Since:

3.0

See Also:

QBChatDialogParticipantListener

getOnlineUsers

@Deprecated
public java.util.Collection<java.lang.Integer> getOnlineUsers()
                                                                   throws XMPPException,
                                                                          SmackException.NotConnectedException

Deprecated. since 3.3.3, see requestOnlineUsers()

Returns a collection of online users IDs in the group chat.

Throws:

XMPPException.XMPPErrorException - if you don't have enough privileges to get this information.

XMPPException

SmackException.NotConnectedException

requestOnlineUsers

public java.util.Collection<java.lang.Integer> requestOnlineUsers()
                                                           throws XMPPException.XMPPErrorException,
                                                                  SmackException.NotConnectedException,
                                                                  SmackException.NoResponseException

Returns a collection of online users IDs in the group chat.

Returns:

collection of online users IDs in the group chat.

Throws:

XMPPException.XMPPErrorException - if the operation failed for some reason.

SmackException.NotConnectedException - if current user not connected to the chat.

SmackException.NoResponseException - if didn't get response for a specified reply timeout.

sendPresence

public void sendPresence(java.util.Map<java.lang.String,java.lang.String> extendedParameters)
                  throws XMPPException,
                         SmackException.NotConnectedException,
                         java.lang.IllegalStateException

Sends the presence with custom parameters to the group chat.

Parameters:

extendedParameters - The map of parameters.

Throws:

XMPPException

SmackException.NotConnectedException

java.lang.IllegalStateException

Since:

3.0

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class QBEntity

hashCode

public int hashCode()

Overrides:

hashCode in class QBEntity

toString

public java.lang.String toString()

Overrides:

toString in class QBEntity