abs.ixi.client

Class ChatManager

java.lang.Object

abs.ixi.client.core.AbstractPacketForwarder

abs.ixi.client.ChatManager

All Implemented Interfaces:

PacketCollector, PacketForwarder

public class ChatManager
extends AbstractPacketForwarder
implements PacketCollector

ChatManager manages user conversations. ChatManager uses XMPPStreamManager to manage xmpp stream with remote server. It is important to note that a XMPPStreamManager can manage a single stream at a time.

There is no synchronous interface available for ChatManager as messaging services are inherently asynchronous.

Constructor Summary

Constructors

Constructor and Description
ChatManager(XMPPStreamManager streamManager)

Method Summary

Modifier and Type	Method and Description
void	collect(Packet packet) This collector takes the given packet.
FileTransferFuture	downloadFile(JID from, String fileId, ContentType contentType) Download a file for which a Message with media content has been received.
void	downloadFile(JID from, String fileId, ContentType contentType, Callback<File,FileTransfer.FailureReason> callback) Download a file for which a Message with media content has been received.
void	enableFileTransfer(FileInstanceSupplier fileSupplier) By default, file transfer is not enabled for a chat conversation.
void	enableFileTransfer(InboundFileTransferFilter filter, FileInstanceSupplier fileSupplier) By default, file transfer is not enabled for a chat conversation.
boolean	say(String messageId, String text, JID to) Convenience method to send a text message to a JID.
boolean	say(String messageId, String text, JID to, boolean isGroup) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	say(String messageId, String text, JID to, boolean isGroup, boolean isMarkable) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	say(String conversationId, String messageId, String text, JID to, boolean isGroup, boolean isMarkable) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	send(Message msg) Write Message packet on to wire using XMPPStreamManager
boolean	sendComposingCSN(JID to) Sending COMPOSING chat state notification explained in XEP-0085(Chat State Notifications)
boolean	sendGoneCSN(JID to) Sending GONE chat state notification explained in XEP-0085(Chat State Notifications)
boolean	sendInactiveCSN(JID to) Sending INACTIVE chat state notification explained in XEP-0085(Chat State Notifications)
boolean	sendMarkableMessage(String messageId, String text, JID to, boolean isGroup) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	sendMarkableMessage(String conversationId, String messageId, String text, JID to, boolean isGroup) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	sendMarkableMessageWithCSN(String messageId, String text, JID to, boolean isGroup) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	sendMarkableMessageWithCSN(String conversationId, String messageId, String text, JID to, boolean isGroup) A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	sendMediaMessage(String conversationId, String messageId, ContentType contentType, String mediaThumb, JID toJID, boolean isGroup, boolean isMarkable, boolean isMDRSupported, boolean isCSNSupported) A Message packet is created with the given mediaId and sent to XMPPStreamManager which writes it on the underlying connection.
boolean	sendMsgCMAcknowledgedReceipt(String messageId, JID to, boolean isGroup) Sending message acknowledged receipt to sender explained in XEP-0333(Chat Markers)
boolean	sendMsgCMDisplayedReceipt(String messageId, JID to, boolean isGroup) Sending message displayed receipt to sender explained in XEP-0333(Chat Markers)
boolean	sendMsgCMReceivedReceipt(String messageId, JID to, boolean isGroup) Sending message received receipt to sender explained in XEP-0333(Chat Markers)
boolean	sendMsgMDRReceivedReceipt(String messageId, JID to, boolean isGroup) Sending message received receipt to sender explained in XEP-0184(Message Deliver receipt)
boolean	sendPausedCSN(JID to) Sending PAUSED chat state notification explained in XEP-0085(Chat State Notifications)
boolean	sendTextMessage(String conversationId, String messageId, String text, JID to, boolean isGroup, boolean isMarkable, boolean isMDRSupported, boolean isCSNSupported) Send a message
void	uploadFile(String mediaId, File file, ContentType contentType, JID to, Callback<String,FileTransfer.FailureReason> callback) Upload a file on to server

Methods inherited from class abs.ixi.client.core.AbstractPacketForwarder

addPacketCollector, addPacketCollector, forwardDefault, forwardPacket, removePacketCollector, removePacketCollector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChatManager

public ChatManager(XMPPStreamManager streamManager)

Method Detail

enableFileTransfer

public void enableFileTransfer(FileInstanceSupplier fileSupplier)
                        throws InitializationErrorException

By default, file transfer is not enabled for a chat conversation. If a file is sent when file transfer is disabled, FileTransferDisabledException will be thrown; and if a file is received when file transfer is disbled for SDK, the file received request will be ignored silently.

As part of FileTransfer processing, FileTransferManager writes file on to the disk. In order to write the file, a File instance is required which is injected through FileInstanceSupplier

Parameters:

fileSupplier - FileInstanceSupplier implementation to supply File instance

Throws:

InitializationErrorException - if the FileTransferManager Initialisation fails

enableFileTransfer

public void enableFileTransfer(InboundFileTransferFilter filter,
                               FileInstanceSupplier fileSupplier)
                        throws InitializationErrorException

By default, file transfer is not enabled for a chat conversation. If a file is sent when file transfer is disabled, FileTransferDisabledException will be thrown; and if a file is received when file transfer is disbled for SDK, the file received request will be ignored silently.

As part of FileTransfer processing, FileTransferManager writes file on to the disk. In order to write the file, a File instance is required which is injected through FileInstanceSupplier

Parameters:

filter - InboundFileTransferFilter implementation which is used to accept/reject FileTransfers

fileSupplier - FileInstanceSupplier implementation to supply File instance

Throws:

InitializationErrorException - if the FileTransferManager initialization fails

downloadFile

public void downloadFile(JID from,
                         String fileId,
                         ContentType contentType,
                         Callback<File,FileTransfer.FailureReason> callback)

Download a file for which a Message with media content has been received.

Parameters:

from - JID of the sender

fileId - unique id of the file; this is received in Message

contentType - content type of the file; received in Message

callback - instance from client which will be invoked with the result of file download

downloadFile

public FileTransferFuture downloadFile(JID from,
                                       String fileId,
                                       ContentType contentType)

Download a file for which a Message with media content has been received.

Parameters:

from - JID of the sender

fileId - unique id of the file; this is received in Message

contentType - content type of the file; received in Message

Returns:

FileTransferFuture

uploadFile

public void uploadFile(String mediaId,
                       File file,
                       ContentType contentType,
                       JID to,
                       Callback<String,FileTransfer.FailureReason> callback)

Upload a file on to server

Parameters:

mediaId - Id for media message

file - File object of media

contentType - ContentType of media file

to - JID of media message receiver

callback - callback to know file transfer status

say

public boolean say(String messageId,
                   String text,
                   JID to)

Convenience method to send a text message to a JID. A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection.

Parameters:

messageId - unique id of the message

text - raw text to be sent to server within a message packet

to - receiver JID

Returns:

true if the message was handed over to writer otherwise false

say

public boolean say(String messageId,
                   String text,
                   JID to,
                   boolean isGroup)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.

Parameters:

messageId - uniqueId of the message packet

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group' otherwise false

Returns:

true if the message was queued up in writer queue otherwise false

say

public boolean say(String messageId,
                   String text,
                   JID to,
                   boolean isGroup,
                   boolean isMarkable)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group. And a true value for flag 'isMarkable' indicates that this message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

messageId - uniqueId of the message packet

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group otherwise false

isMarkable - true for getting delivery and read receipt

Returns:

true if the message was queued up in writer queue successfully otherwise false

say

public boolean say(String conversationId,
                   String messageId,
                   String text,
                   JID to,
                   boolean isGroup,
                   boolean isMarkable)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group. And a true value for flag 'isMarkable' indicates that this message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

conversationId - conversationId

messageId - uniqueId of the message packet

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group otherwise false

isMarkable - true for getting delivery and read receipt.

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMarkableMessage

public boolean sendMarkableMessage(String messageId,
                                   String text,
                                   JID to,
                                   boolean isGroup)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.And this * message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

messageId - uniqueId of the message packet

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group' otherwise false

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMarkableMessage

public boolean sendMarkableMessage(String conversationId,
                                   String messageId,
                                   String text,
                                   JID to,
                                   boolean isGroup)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.And this * message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

conversationId - uniqueId for conversation

messageId - uniqueId of the message packet

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group' otherwise false

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMarkableMessageWithCSN

public boolean sendMarkableMessageWithCSN(String messageId,
                                          String text,
                                          JID to,
                                          boolean isGroup)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.And this * message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

messageId - uniqueId of the message

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group' otherwise false

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMarkableMessageWithCSN

public boolean sendMarkableMessageWithCSN(String conversationId,
                                          String messageId,
                                          String text,
                                          JID to,
                                          boolean isGroup)

A Message packet is created with the given text and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.And this * message is intended to get delivery and read receipt according to XEP-0333(Chat-Markers).

Parameters:

conversationId - conversationId

messageId - uniqueId of the message

text - raw text to be sent to server within a message packet

to - receiver JID

isGroup - true if messages being sent to a group' otherwise false

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMediaMessage

public boolean sendMediaMessage(String conversationId,
                                String messageId,
                                ContentType contentType,
                                String mediaThumb,
                                JID toJID,
                                boolean isGroup,
                                boolean isMarkable,
                                boolean isMDRSupported,
                                boolean isCSNSupported)

A Message packet is created with the given mediaId and sent to XMPPStreamManager which writes it on the underlying connection. A true value for flag 'isGroup' indicates that messages is intended to be sent to a group.

Parameters:

conversationId - conversationId

messageId - messageId

contentType - contentType of the file being sent

mediaThumb - Base64 encoded media thumb

toJID - receiver JID

isGroup - true if messages being sent to a group' otherwise false

isMarkable - is Need Chat Markers (XEP-0333)

isMDRSupported - isMDRSupported

isCSNSupported - isCSNSupported

Returns:

true if the message was queued up in writer queue otherwise false

sendTextMessage

public boolean sendTextMessage(String conversationId,
                               String messageId,
                               String text,
                               JID to,
                               boolean isGroup,
                               boolean isMarkable,
                               boolean isMDRSupported,
                               boolean isCSNSupported)

Send a message

Parameters:

conversationId - conversationId

messageId - messageId

text - message text

to - receiver JID

isGroup - true if the message is sent to a group

isMarkable - is Need Chat Markers (XEP-0333)

isMDRSupported - isMDRSupported

isCSNSupported - is support Chat State Notification (XEP-0085)

Returns:

true if the message was queued up in writer queue for delivery otherwise false

sendMsgMDRReceivedReceipt

public boolean sendMsgMDRReceivedReceipt(String messageId,
                                         JID to,
                                         boolean isGroup)

Sending message received receipt to sender explained in XEP-0184(Message Deliver receipt)

Parameters:

messageId - received message id

to - message sender JID

isGroup - isGroup flag

Returns:

true if the message was queued up in writer queue successfully otherwise false

sendMsgCMReceivedReceipt

public boolean sendMsgCMReceivedReceipt(String messageId,
                                        JID to,
                                        boolean isGroup)

Sending message received receipt to sender explained in XEP-0333(Chat Markers)

Parameters:

messageId - received message id

to - message sender JID

isGroup - isGroup

Returns:

true if the message was queued up in writer queue for delivery otherwise false

sendMsgCMDisplayedReceipt

public boolean sendMsgCMDisplayedReceipt(String messageId,
                                         JID to,
                                         boolean isGroup)

Sending message displayed receipt to sender explained in XEP-0333(Chat Markers)

Parameters:

messageId - received message id

to - message sender JID

isGroup - isGroup

Returns:

true if the message was queued up in writer queue otherwise false

sendMsgCMAcknowledgedReceipt

public boolean sendMsgCMAcknowledgedReceipt(String messageId,
                                            JID to,
                                            boolean isGroup)

Sending message acknowledged receipt to sender explained in XEP-0333(Chat Markers)

Parameters:

messageId - received message id

to - message sender JID

isGroup - isGroup flag

Returns:

true if the message was queued up in writer queue for delivery otherwise false

sendInactiveCSN

public boolean sendInactiveCSN(JID to)

Sending INACTIVE chat state notification explained in XEP-0085(Chat State Notifications)

Parameters:

to - contact JID

Returns:

true if the packet was queued up in writer queue for delivery otherwise false

sendComposingCSN

public boolean sendComposingCSN(JID to)

Sending COMPOSING chat state notification explained in XEP-0085(Chat State Notifications)

Parameters:

to - contact JID

Returns:

true if the packet was queued up in writer queue for delivery otherwise false

sendPausedCSN

public boolean sendPausedCSN(JID to)

Sending PAUSED chat state notification explained in XEP-0085(Chat State Notifications)

Parameters:

to - contact JID

Returns:

true if the packet was queued up in writer queue for delivery otherwise false

sendGoneCSN

public boolean sendGoneCSN(JID to)

Sending GONE chat state notification explained in XEP-0085(Chat State Notifications)

Parameters:

to - contact JID

Returns:

true if the packet was queued up in writer queue for delivery otherwise false

send

public boolean send(Message msg)

Write Message packet on to wire using XMPPStreamManager

Parameters:

msg - outbound Message packet

Returns:

true if the message was successfully written on the connection; false if the

collect

public void collect(Packet packet)

Description copied from interface: PacketCollector

This collector takes the given packet. The collector may employ further filtering and may decide to ignore/drop this packet.

Specified by:

collect in interface PacketCollector

Parameters:

packet - packet instance to be collected