com.ca.wrapper

Class CSChat

java.lang.Object

com.ca.wrapper.CSChat

public class CSChat
extends java.lang.Object

This class contains all chat apis App will be notified by LocalBroadcastManager for asynchronous results of apis.

See Also:

CSEvents, CSChatReceiver

Constructor Summary

Constructors

Constructor and Description
CSChat()

Method Summary

Modifier and Type	Method and Description
boolean	cancelTransfer(java.lang.String chatid) Cancel file transfer either upload or download.
boolean	deleteChatMessagebyfilter(java.lang.String filter, java.lang.String value, boolean remotedelete) deleteChatMessagebyfilter.It also cancels if any file transfers are in progress related to, to be deleted messages.
boolean	deleteSMSMessagebyfilter(java.lang.String filter, java.lang.String value) deleteSMSMessagebyfilter.
void	downloadFile(java.lang.String chatid) download a File in async mode
boolean	enableAutoDownloadOfFilesInChat(boolean autodownload) enableAutoDownloadOfFilesInChat.
CSChatContact	getContactFromChatID(java.lang.String chatid) get Contact data From ChatID
org.json.JSONObject	getDirectoryListing() getDirectoryListing created by sdk which can be used in chat to save images,videos etc.
CSLocation	getLocationFromChatID(java.lang.String chatid) get Location data From ChatID
CSConstants.CHATFTDOWNLOADPREFNW	getPreferredNWToDownloadFilesInChat() getPreferredNWToDownloadFilesInChat.
boolean	getPresence(java.util.List<java.lang.String> remoteids) get Presence status
boolean	isAutoDownloadOfFilesInChatEnabled() isAutoDownloadOfFilesInChatEnabled.
boolean	pauseTransfer(java.lang.String chatid) Pause file transfer either upload or download.
boolean	resumeTransfer(java.lang.String chatid) Resume file transfer either upload or download.
boolean	sendAudio(java.lang.String remoteid, java.lang.String filepath, boolean isgroupmessage, java.lang.String replychatid) send an Audio to a user
boolean	sendContact(java.lang.String remoteid, CSChatContact cschatContact, boolean isgroupmessage, java.lang.String replychatid) send Contact to a user
boolean	sendDocument(java.lang.String remoteid, java.lang.String filepath, boolean isgroupmessage, java.lang.String replychatid) send an Document to a user
void	sendIsTyping(java.lang.String remoteid, boolean isgroup, boolean istyping) send Is Typing
boolean	sendLocation(java.lang.String remoteid, CSLocation cschatlocation, boolean isgroupmessage, java.lang.String replychatid) send location to a user or group
boolean	sendMessage(java.lang.String remoteid, java.lang.String message, boolean isgroupmessage, java.lang.String replychatid) send Chat message to a user.At maximum ~16kB of data can only be sent.
boolean	sendPhoto(java.lang.String remoteid, java.lang.String photofilepath, boolean isgroupmessage, java.lang.String replychatid) send an image to a user
boolean	sendReadReceipt(java.lang.String chatID) send Chat message read status.This api marks message as read locally even if message is queued to be sent.
boolean	sendSMS(java.lang.String remotenumber, java.lang.String didnumber, java.lang.String message, java.lang.String replysmsid) send SMS message to a user.
boolean	sendSMSReadReceipt(java.lang.String smsID) send Sms message read status.This api marks sms as read locally even if message is queued to be sent.
boolean	sendVideo(java.lang.String remoteid, java.lang.String filepath, boolean isgroupmessage, java.lang.String replychatid) send an video to a user
boolean	setPreferredNWToDownloadFilesInChat(CSConstants.CHATFTDOWNLOADPREFNW prefnw) setPreferredNWToDownloadFilesInChat.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSChat

public CSChat()

Method Detail

sendMessage

public boolean sendMessage(java.lang.String remoteid,
                           java.lang.String message,
                           boolean isgroupmessage,
                           java.lang.String replychatid)

send Chat message to a user.At maximum ~16kB of data can only be sent.

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

message - message

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED

sendLocation

public boolean sendLocation(java.lang.String remoteid,
                            CSLocation cschatlocation,
                            boolean isgroupmessage,
                            java.lang.String replychatid)

send location to a user or group

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

cschatlocation - CSLocation

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED

sendContact

public boolean sendContact(java.lang.String remoteid,
                           CSChatContact cschatContact,
                           boolean isgroupmessage,
                           java.lang.String replychatid)

send Contact to a user

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

cschatContact - CALAudio

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED

sendPhoto

public boolean sendPhoto(java.lang.String remoteid,
                         java.lang.String photofilepath,
                         boolean isgroupmessage,
                         java.lang.String replychatid)

send an image to a user

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

photofilepath - filepath

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED CSCHAT_UPLOADPROGRESS CSCHAT_UPLOADFILEFAILED CSCHAT_UPLOADFILEDONE CSCLIENT_PERMISSION_NEEDED

sendVideo

public boolean sendVideo(java.lang.String remoteid,
                         java.lang.String filepath,
                         boolean isgroupmessage,
                         java.lang.String replychatid)

send an video to a user

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

filepath - filepath

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED CSCHAT_UPLOADPROGRESS CSCHAT_UPLOADFILEFAILED CSCHAT_UPLOADFILEDONE CSCLIENT_PERMISSION_NEEDED

sendDocument

public boolean sendDocument(java.lang.String remoteid,
                            java.lang.String filepath,
                            boolean isgroupmessage,
                            java.lang.String replychatid)

send an Document to a user

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

filepath - filepath of the document

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED CSCHAT_UPLOADPROGRESS CSCHAT_UPLOADFILEFAILED CSCHAT_UPLOADFILEDONE CSCLIENT_PERMISSION_NEEDED

sendAudio

public boolean sendAudio(java.lang.String remoteid,
                         java.lang.String filepath,
                         boolean isgroupmessage,
                         java.lang.String replychatid)

send an Audio to a user

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

filepath - filepath

isgroupmessage - true for group message false for user message

replychatid - chatid to reply by quoting

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED CSCHAT_UPLOADPROGRESS CSCHAT_UPLOADFILEFAILED CSCHAT_UPLOADFILEDONE CSCLIENT_PERMISSION_NEEDED

getContactFromChatID

public CSChatContact getContactFromChatID(java.lang.String chatid)

get Contact data From ChatID

Parameters:

chatid - chatid

Returns:

CALAudio

getLocationFromChatID

public CSLocation getLocationFromChatID(java.lang.String chatid)

get Location data From ChatID

Parameters:

chatid - chatid

Returns:

CSChatLocation

downloadFile

public void downloadFile(java.lang.String chatid)

download a File in async mode

Parameters:

chatid - chatid

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCHAT_DOWNLOADFILEDONE CSCHAT_DOWNLOADFILEFAILED CSCHAT_DOWNLOADPROGRESS CSCLIENT_PERMISSION_NEEDED

pauseTransfer

public boolean pauseTransfer(java.lang.String chatid)

Pause file transfer either upload or download.

Parameters:

chatid - chatid

Returns:

returns either success or failure

resumeTransfer

public boolean resumeTransfer(java.lang.String chatid)

Resume file transfer either upload or download.

Parameters:

chatid - chatid

Returns:

returns either success or failure

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_PERMISSION_NEEDED

cancelTransfer

public boolean cancelTransfer(java.lang.String chatid)

Cancel file transfer either upload or download.

Parameters:

chatid - chatid

Returns:

returns either success or failure

sendReadReceipt

public boolean sendReadReceipt(java.lang.String chatID)

send Chat message read status.This api marks message as read locally even if message is queued to be sent.

Parameters:

chatID - chatID

Returns:

true or false

See Also:

CSChatReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_CHATUPDATED

getPresence

public boolean getPresence(java.util.List<java.lang.String> remoteids)

get Presence status

Parameters:

remoteids - list of loginids of users to get Presence status

Returns:

true or false

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCHAT_GETPRESENCE_RESPONSE

getDirectoryListing

public org.json.JSONObject getDirectoryListing()

getDirectoryListing created by sdk which can be used in chat to save images,videos etc. Example Format is: {"IamLive":{"Audios":["Sent","Received"],"Documents":["Sent","Received"],"Profile Photos":"","Images":["Sent","Received"],"Thumbnails":"","Videos":["Sent","Received"]}}

Returns:

JSONObject containing directory listing

sendIsTyping

public void sendIsTyping(java.lang.String remoteid,
                         boolean isgroup,
                         boolean istyping)

send Is Typing

Parameters:

remoteid - loginid of user in case of user chat or groupid in case of group chat

isgroup - is group

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR

deleteChatMessagebyfilter

public boolean deleteChatMessagebyfilter(java.lang.String filter,
                                         java.lang.String value,
                                         boolean remotedelete)

deleteChatMessagebyfilter.It also cancels if any file transfers are in progress related to, to be deleted messages. Chat mesages at other end will be deleted only by push or when other end comes online.

Parameters:

filter - filter

value - value

remotedelete - true to delete sent messages from remote end.

Returns:

success or failure.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCHAT_CHATDELETED

enableAutoDownloadOfFilesInChat

public boolean enableAutoDownloadOfFilesInChat(boolean autodownload)

enableAutoDownloadOfFilesInChat. Enable or disable auto download of files in chat.

Parameters:

autodownload - true or false

Returns:

success or failure.

See Also:

setPreferredNWToDownloadFilesInChat(com.ca.Utils.CSConstants.CHATFTDOWNLOADPREFNW)

isAutoDownloadOfFilesInChatEnabled

public boolean isAutoDownloadOfFilesInChatEnabled()

isAutoDownloadOfFilesInChatEnabled. Returns whether auto download of files in chat are enabled or not.

Returns:

true or false

setPreferredNWToDownloadFilesInChat

public boolean setPreferredNWToDownloadFilesInChat(CSConstants.CHATFTDOWNLOADPREFNW prefnw)

setPreferredNWToDownloadFilesInChat. set preferred NW to download files in chat.

Parameters:

prefnw - prefnw.

Returns:

success or failure.

getPreferredNWToDownloadFilesInChat

public CSConstants.CHATFTDOWNLOADPREFNW getPreferredNWToDownloadFilesInChat()

getPreferredNWToDownloadFilesInChat. gets preferred NW to download files in chat

Returns:

CHATFTDOWNLOADPREFNW

sendSMS

public boolean sendSMS(java.lang.String remotenumber,
                       java.lang.String didnumber,
                       java.lang.String message,
                       java.lang.String replysmsid)

send SMS message to a user.

Parameters:

remotenumber - remotenumber of user

didnumber - didnumber

message - message

replysmsid - smsid of quoting message. pass null or empty string if message don't need to quote previous sms. This feature is supported for out going SMS.

Returns:

true or false

See Also:

CSSmsReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSSMS_SMSUPDATED

sendSMSReadReceipt

public boolean sendSMSReadReceipt(java.lang.String smsID)

send Sms message read status.This api marks sms as read locally even if message is queued to be sent.

Parameters:

smsID - smsID

Returns:

true or false

See Also:

CSSmsReceiver

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSSMS_SMSUPDATED

deleteSMSMessagebyfilter

public boolean deleteSMSMessagebyfilter(java.lang.String filter,
                                        java.lang.String value)

deleteSMSMessagebyfilter.

Parameters:

filter - filter

value - value

Returns:

success or failure.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSSMS_SMSDELETED