com.comapi.chat

Class ComapiChatClient

java.lang.Object

com.comapi.chat.ComapiChatClient

public class ComapiChatClient
extends java.lang.Object

Client implementation for chat layer SDK. Handles initialisation and stores all internal objects.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComapiChatClient.ExtHelper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComapiChatClient(android.app.Application app, RxComapiClient client, ChatConfig chatConfig, EventsHandler eventsHandler, CallbackAdapter callbackAdapter) Recommended constructor.

Method Summary

Modifier and Type	Method and Description
void	addListener(ParticipantsListener participantsListener) Registers listener for changes in participant list in conversations.
void	addListener(ProfileListener profileListener) Registers listener for changes in profile details.
void	addListener(TypingListener typingListener) Registers listener for user is typing/finished typing events.
void	close(android.content.Context context) Method to close the client state, won't be usable anymore.
<any>	copyLogs(java.io.File file) Gets the content of internal log files merged into provided file.
ProfileManager	createProfileManager(android.content.Context context) Create ProfileManager to manage profile data.
<any>	getLogs() Deprecated. Use safer version - this#copyLogs(File) instead.
Session	getSession() Gets the active session data.
int	getState() Gets the internal state of the SDK.
void	removeListener(ParticipantsListener participantsListener) Removes listener for changes in participant list in conversations.
void	removeListener(ProfileListener profileListener) Removes listener for changes in profile details.
void	removeListener(TypingListener typingListener) Removes listener for user is typing/finished typing events.
RxChatServiceAccessor	rxService() Access to reactive Comapi service APIs.
ChatServiceAccessor	service() Access to Comapi service APIs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComapiChatClient

protected ComapiChatClient(android.app.Application app,
                           RxComapiClient client,
                           ChatConfig chatConfig,
                           EventsHandler eventsHandler,
                           CallbackAdapter callbackAdapter)

Recommended constructor.

Parameters:

app - Application instance.

client - Comapi Foundation SDK client.

chatConfig - SDK configuration.

eventsHandler - Socket events handler.

callbackAdapter - Adapts Observables to callback APIs.

Method Detail

getSession

public Session getSession()

Gets the active session data.

Returns:

Active session data.

rxService

public RxChatServiceAccessor rxService()

Access to reactive Comapi service APIs.

Returns:

Comapi reactive service APIs.

service

public ChatServiceAccessor service()

Access to Comapi service APIs.

Returns:

Comapi service APIs.

getState

public int getState()

Gets the internal state of the SDK. Possible values in com.comapi.GlobalState.

Returns:

State of the ComapiImpl SDK. Compare with values in com.comapi.GlobalState.

copyLogs

public <any> copyLogs(java.io.File file)

Gets the content of internal log files merged into provided file.

Parameters:

file - File to merge internal logs into.

Returns:

Observable emitting the same file but this time containing all the internal logs merged into.

getLogs

@Deprecated
public <any> getLogs()

Deprecated. Use safer version - this#copyLogs(File) instead.

Returns the content of internal log files in a single String. For large limits of internal files consider using copyLogs(File) and loading the content line by line.

Returns:

Observable emitting internal log files content as a single string.

close

public void close(android.content.Context context)

Method to close the client state, won't be usable anymore. Useful e.g. for unit testing.

Parameters:

context - Context.

addListener

public void addListener(ParticipantsListener participantsListener)

Registers listener for changes in participant list in conversations. Delivers participant added, updated and removed events.

Parameters:

participantsListener - Listener for changes in participant list in conversations.

removeListener

public void removeListener(ParticipantsListener participantsListener)

Removes listener for changes in participant list in conversations.

Parameters:

participantsListener - Listener for changes in participant list in conversations.

addListener

public void addListener(ProfileListener profileListener)

Registers listener for changes in profile details.

Parameters:

profileListener - Listener for changes in in profile details.

removeListener

public void removeListener(ProfileListener profileListener)

Removes listener for changes in profile details.

Parameters:

profileListener - Listener for changes in in profile details.

addListener

public void addListener(TypingListener typingListener)

Registers listener for user is typing/finished typing events.

Parameters:

typingListener - Listener for user is typing/finished typing events.

removeListener

public void removeListener(TypingListener typingListener)

Removes listener for user is typing/finished typing events.

Parameters:

typingListener - Listener for user is typing/finished typing events.

createProfileManager

public ProfileManager createProfileManager(android.content.Context context)

Create ProfileManager to manage profile data.

Parameters:

context - Application context.

Returns:

ProfileManager to manage profile data.