com.ca.wrapper

Class CSClient

java.lang.Object

com.ca.wrapper.CSClient

public class CSClient
extends java.lang.Object

This class contains initialization, authentication and helper apis. App will be notified by LocalBroadcastManager for asynchronous results of apis.

See Also:

CSEvents

Constructor Summary

Constructors

Constructor and Description
CSClient()

Method Summary

Modifier and Type	Method and Description
boolean	activate(java.lang.String loginid, java.lang.String otp) Activate the user with or without otp.
boolean	addContacts(java.util.ArrayList<CSContact> CScontacts) addContact.
boolean	blockUser(java.lang.String remoteid) blockUser
boolean	deleteContact(java.lang.String uniqueidentifier) deleteContact.Contacts other than of type CONTACTTYPE_MOBILE can only be deleted.
void	deleteProfilePhoto() delete Profile Photo
boolean	enablecallLogActivityinChat(boolean enable) enablecallLogActivityinChat.If true call log will be logged into chat.
boolean	enableGroupActivityinChat(boolean enable) enableGroupActivityinChat.If true Group activity will be logged into chat.
boolean	enableNativeContacts(boolean read, int defaultregioncode) enableNativeContacts.
boolean	enablePublicReadOfProfileandChatFiles(boolean read) enablePublicReadOfProfileandChatFiles.
boolean	enableUserActivityinChat(boolean enable) enableUserActivityinChat.If true user activity will be logged into chat.
java.lang.String	getInternationalFormatNumber(java.lang.String loginid, java.lang.String countryCode) getInternationFormatNumber
static boolean	getLoginstatus() getLoginstatus
boolean	getProfile(java.lang.String remoteid) gets UserProfile.
boolean	getPublicReadOfProfileandChatFilesStatus() getPublicReadOfProfileandChatFilesStatus
boolean	getRecentLogcat(java.lang.String filepath) writes recent logcat to given filepath
CSExplicitEventReceivers	getRegisteredExplicitEventReceivers() getRegisteredExplicitEventReceivers
boolean	getSelfProfile() gets SelfProfile.
long	getTime() getTime
static java.lang.String	getVersion() getVersion of sdk
void	initialize(java.lang.String server, int port, CSAppDetails csAppDetails) initializes sdk.
boolean	iscallLogActivityinChatEnabled() isGroupActivityinChatEnabled
boolean	isGroupActivityinChatEnabled() isGroupActivityinChatEnabled
boolean	isnativeContactsCanbeRead() isnativeContactsCanbeRead.
boolean	isUserActivityinChatEnabled() isUserActivityinChatEnabled
boolean	login(java.lang.String loginid, java.lang.String password) Login the user
void	processInstanceID(android.content.Context context, java.lang.String token) processInstanceID.
void	processPushMessage(android.content.Context context, com.google.firebase.messaging.RemoteMessage remoteMessage) processPushMessage.
boolean	registerExplicitEventReceivers(CSExplicitEventReceivers ExplicitEventReceivers) registerExplicitEventReceivers.
boolean	registerForPSTNCalls() register For PSTN Calls.App should call this api atleast once to enable pstn calling after initialization.
boolean	reSendActivationCode(boolean throughcall) reSendActivationCode
boolean	reset() resets Db and network module.Once reset is done App must do initialization followed by signup and activation or login.
boolean	setContactasFavourite(java.lang.String contact, boolean set) setContactasFavourite.
void	setProfile(java.lang.String displayname, java.lang.String statusmessage, java.lang.String profilephotopath) sets UserProfile.Passing profilephotopath null or empty will remove profile image if any.
boolean	signUp(java.lang.String loginid, java.lang.String password, boolean autoactivate) signUp the user
boolean	startFileLogging(java.lang.String file, java.lang.String loglevel, boolean append) startFileLogging.All the log will be written to given file until stopFileLogging is called or upto 30 minutes
boolean	startwritingLogcatToFile(java.lang.String file, boolean append) start writing Logcat To the given File.
boolean	stopFileLogging() stopFileLogging
boolean	stopwritingLogcatToFile() stop writing Logcat To File
boolean	syncNativeContacts(int defaultregioncode) sync native Contacts.If sdk is not in logged in state,Contacts will be auto synced once successful login made.
boolean	unBlockUser(java.lang.String remoteid) unBlockUser
boolean	updateAppDetails(CSAppDetails csAppDetails) update App details.
boolean	updatePassword(java.lang.String oldpassword, java.lang.String newpassword) updates Password
boolean	updateServerDetails(java.lang.String server, int port) update Server details.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSClient

public CSClient()

Method Detail

initialize

public void initialize(java.lang.String server,
                       int port,
                       CSAppDetails csAppDetails)

initializes sdk. To use vox CPaaS cloud, pass server as null and port as 0. App details are must to use vox CPaaS cloud servers. If initialization is already success at least once in app life time, this api simply do login when it is called.

Parameters:

server - server ip

port - server port

csAppDetails - dao object with app details like appname,appid.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCLIENT_INITILIZATION_RESPONSE CSCLIENT_LOGIN_RESPONSE

updateAppDetails

public boolean updateAppDetails(CSAppDetails csAppDetails)

update App details.

Parameters:

csAppDetails - dao object with app details like appname,customerid,appid,appsecrete.

Returns:

returns success or failure.

reset

public boolean reset()

resets Db and network module.Once reset is done App must do initialization followed by signup and activation or login.

Returns:

returns success or failure.

getVersion

public static java.lang.String getVersion()

getVersion of sdk

Returns:

returns sdk version

getTime

public long getTime()

getTime

Returns:

returns UTC time

startFileLogging

public boolean startFileLogging(java.lang.String file,
                                java.lang.String loglevel,
                                boolean append)

startFileLogging.All the log will be written to given file until stopFileLogging is called or upto 30 minutes

Parameters:

file - file to write the log.

loglevel - can be any of ERROR WARN INFO DEBUG TRACE ALL. If not loglevel defaults to DEBUG

append - true to append the log if file already exists or false to create fresh log file.

Returns:

returns success or failure

stopFileLogging

public boolean stopFileLogging()

stopFileLogging

Returns:

returns success or failure

startwritingLogcatToFile

public boolean startwritingLogcatToFile(java.lang.String file,
                                        boolean append)

start writing Logcat To the given File. It stops after 30 minutes if not stopped by calling stopwritingLogcatToFile api.

Parameters:

file - filepath to write the log.Make sure file path don't have any spaces.

append - true to append the log if file already exists or false to create fresh log file.

Returns:

returns success or failure

stopwritingLogcatToFile

public boolean stopwritingLogcatToFile()

stop writing Logcat To File

Returns:

returns success or failure

getRecentLogcat

public boolean getRecentLogcat(java.lang.String filepath)

writes recent logcat to given filepath

Parameters:

filepath - filepath to write the log.

Returns:

returns success or failure

updatePassword

public boolean updatePassword(java.lang.String oldpassword,
                              java.lang.String newpassword)

updates Password

Parameters:

oldpassword - oldpassword

newpassword - newpassword

Returns:

returns success if old password matches with the given one and the results will be notified by LocalBroadcastManager

Events:

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

setProfile

public void setProfile(java.lang.String displayname,
                       java.lang.String statusmessage,
                       java.lang.String profilephotopath)

sets UserProfile.Passing profilephotopath null or empty will remove profile image if any.

Parameters:

displayname - display name

statusmessage - description

profilephotopath - user image path

Events:

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

getProfile

public boolean getProfile(java.lang.String remoteid)

gets UserProfile.

Parameters:

remoteid - loginid of user profile to get

Returns:

true or false

Events:

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

getSelfProfile

public boolean getSelfProfile()

gets SelfProfile. This api will be useful to get existing self profile information from server when user logged in different device.

Returns:

true or false

Events:

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

deleteProfilePhoto

public void deleteProfilePhoto()

delete Profile Photo

Events:

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

getLoginstatus

public static boolean getLoginstatus()

getLoginstatus

Returns:

returns true or false

addContacts

public boolean addContacts(java.util.ArrayList<CSContact> CScontacts)

addContact.

Parameters:

CScontacts - Array List of type CSContact

Returns:

true or false. returns true if request accepted or returns false if contact already exists or self contact is added.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_ADDCONTACT_RESPONSE CSCONTACTS_CONTACTSUPDATED

deleteContact

public boolean deleteContact(java.lang.String uniqueidentifier)

deleteContact.Contacts other than of type CONTACTTYPE_MOBILE can only be deleted.

Parameters:

uniqueidentifier - to be deleted. This can be a contact id or any uniqueidentifier given in addContacts(ArrayList)} addContact} api

Returns:

true or false. returns true if request accepted or returns false if contact doesn't exists.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_DELETECONTACT_RESPONSE CSCONTACTS_CONTACTSUPDATED

isnativeContactsCanbeRead

public boolean isnativeContactsCanbeRead()

isnativeContactsCanbeRead. gets reading of native contacts, is enabled or not.

Returns:

true or false. returns whether reading of native contacts is enabled or not.

setContactasFavourite

public boolean setContactasFavourite(java.lang.String contact,
                                     boolean set)

setContactasFavourite.

Parameters:

set - true to mark contact as favourite.false to mark contact as normal.

contact - contact

Returns:

true or false

enableNativeContacts

public boolean enableNativeContacts(boolean read,
                                    int defaultregioncode)

enableNativeContacts. Specify native contacts should be read or not.If enabled Contacts will be read automatically.This api should be called after initialization

Parameters:

read - true or false

defaultregioncode - default region code to validate a number in case of number without country code

Returns:

true or false

syncNativeContacts

public boolean syncNativeContacts(int defaultregioncode)

sync native Contacts.If sdk is not in logged in state,Contacts will be auto synced once successful login made.

Parameters:

defaultregioncode - default region code to validate a number in case of number without country code

Returns:

true or false.

signUp

public boolean signUp(java.lang.String loginid,
                      java.lang.String password,
                      boolean autoactivate)

signUp the user

Parameters:

loginid - phoneNumber which should be a valid phone number if otp authentication required. getInternationalFormatNumber(String, String) api can be used to get valid International Format Number

password - password

autoactivate - autoactivate. Pass this value as true in case otp authentication is disabled.

Returns:

true or false.

Events:

Below are the events that can be notified by LocalBroadcastManager
CSCLIENT_NETWORKERROR CSCLIENT_SIGNUP_RESPONSE
Below are the further events that can be notified by LocalBroadcastManager if autoactivate is true
CSCLIENT_ACTIVATION_RESPONSE

getInternationalFormatNumber

public java.lang.String getInternationalFormatNumber(java.lang.String loginid,
                                                     java.lang.String countryCode)

getInternationFormatNumber

Parameters:

loginid - phoneNumber

countryCode - countryCode

Returns:

phoneNumber in International Format

login

public boolean login(java.lang.String loginid,
                     java.lang.String password)

Login the user

Parameters:

loginid - loginid

password - password

Returns:

true or false.

Events:

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

activate

public boolean activate(java.lang.String loginid,
                        java.lang.String otp)

Activate the user with or without otp.

Parameters:

loginid - loginid

otp - activationcode

Returns:

true or false.

Events:

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

updateServerDetails

public boolean updateServerDetails(java.lang.String server,
                                   int port)

update Server details. To use vox CPaaS cloud, pass server as null and port as 0

Parameters:

server - server

port - port

Returns:

true or false.

Events:

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

reSendActivationCode

public boolean reSendActivationCode(boolean throughcall)

reSendActivationCode

Parameters:

throughcall - true to get activation code by call, false to get activation code by SMS

Returns:

true or false.

Events:

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

registerForPSTNCalls

public boolean registerForPSTNCalls()

register For PSTN Calls.App should call this api atleast once to enable pstn calling after initialization.

Returns:

true or false.

Events:

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

registerExplicitEventReceivers

public boolean registerExplicitEventReceivers(CSExplicitEventReceivers ExplicitEventReceivers)

registerExplicitEventReceivers. App should register for CSExplicitEvents events by this api.

Parameters:

ExplicitEventReceivers - CSExplicitEventRceivers

Returns:

true or false.

getRegisteredExplicitEventReceivers

public CSExplicitEventReceivers getRegisteredExplicitEventReceivers()

getRegisteredExplicitEventReceivers

Returns:

ExplicitEventReceivers CSExplicitEventRceivers

processPushMessage

public void processPushMessage(android.content.Context context,
                               com.google.firebase.messaging.RemoteMessage remoteMessage)

processPushMessage. This api should be called when ever a new push message, which is intended for sdk, is received by application

Parameters:

context - ApplicationContext

processInstanceID

public void processInstanceID(android.content.Context context,
                              java.lang.String token)

processInstanceID. This api should be called when ever firebase token is refreshed

Parameters:

context - ApplicationContext

token - push token

blockUser

public boolean blockUser(java.lang.String remoteid)

blockUser

Parameters:

remoteid - remoteid of user

Returns:

true or false.

Events:

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

unBlockUser

public boolean unBlockUser(java.lang.String remoteid)

unBlockUser

Parameters:

remoteid - remoteid of user

Returns:

true or false.

Events:

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

enablePublicReadOfProfileandChatFiles

public boolean enablePublicReadOfProfileandChatFiles(boolean read)

enablePublicReadOfProfileandChatFiles. If enabled, and then any file is uploaded into server either in chat or as profile picture,such files can be accessable publicly if url of the file is known.Also disabling public read by using this api will not change already existing file permissions. By default all files are private. This api should be called after initialization

Parameters:

read - true or false

Returns:

true or false

getPublicReadOfProfileandChatFilesStatus

public boolean getPublicReadOfProfileandChatFilesStatus()

getPublicReadOfProfileandChatFilesStatus

Returns:

true or false.

enableGroupActivityinChat

public boolean enableGroupActivityinChat(boolean enable)

enableGroupActivityinChat.If true Group activity will be logged into chat.

Parameters:

enable - true or false

Returns:

true or false

isGroupActivityinChatEnabled

public boolean isGroupActivityinChatEnabled()

isGroupActivityinChatEnabled

Returns:

true or false.

enablecallLogActivityinChat

public boolean enablecallLogActivityinChat(boolean enable)

enablecallLogActivityinChat.If true call log will be logged into chat.

Parameters:

enable - true or false

Returns:

true or false

iscallLogActivityinChatEnabled

public boolean iscallLogActivityinChatEnabled()

isGroupActivityinChatEnabled

Returns:

true or false.

enableUserActivityinChat

public boolean enableUserActivityinChat(boolean enable)

enableUserActivityinChat.If true user activity will be logged into chat.

Parameters:

enable - true or false

Returns:

true or false

isUserActivityinChatEnabled

public boolean isUserActivityinChatEnabled()

isUserActivityinChatEnabled

Returns:

true or false.