ConversationsClient

interface ConversationsClient

Conversations client - main entry point for the Conversations SDK.

Types

ConnectionState

enum ConnectionState

Represents underlying twilsock connection state.

ConversationBuilder

interface ConversationBuilder

Helper to create new conversation with provided data.

FCMToken

open class FCMToken

Class which represents token received by application from the Firebase Cloud Messaging service.

LogLevel

enum LogLevel

Log level constants for passing to setLogLevel.

Properties

interface Properties

Properties for client initialization configuration

SynchronizationStatus

enum SynchronizationStatus

Represents client initialization status.

Functions

addListener

abstract fun addListener(listener: ConversationsClientListener)

Method to add listener for this Client.

conversationBuilder

abstract fun conversationBuilder(): ConversationsClient.ConversationBuilder

Get ConversationBuilder to create conversation with options.

create

open fun create(context: Context, token: String, properties: ConversationsClient.Properties, listener: CallbackListener<ConversationsClient>)

Creates a new Conversations client instance with a token manager and client properties.

createConversation

abstract fun createConversation(friendlyName: String, listener: CallbackListener<Conversation>)

Create a conversation with friendly name.

getAndSubscribeUser

abstract fun getAndSubscribeUser(identity: String, listener: CallbackListener<User>)

Get user based on user identity and subscribe to real-time updates for this user.

getConnectionState

abstract fun getConnectionState(): ConversationsClient.ConnectionState

getConversation

abstract fun getConversation(conversationSidOrUniqueName: String, listener: CallbackListener<Conversation>)

Retrieves a conversation with the specified SID or unique name.

getMyConversations

abstract fun getMyConversations(): List<Conversation>

Request list of user's joined conversations.

getMyIdentity

abstract fun getMyIdentity(): String

Get user identity for current user

getMyUser

abstract fun getMyUser(): User

Get logged in User object.

getParticipantsByIdentity

abstract fun getParticipantsByIdentity(identity: String): List<Participant>

Get list of all Conversation participants with a given identity.

getProperties

abstract fun getProperties(): ConversationsClient.Properties

Get properties for current client

getSdkVersion

open fun getSdkVersion(): String

Returns the version of the Conversations SDK.

getSubscribedUsers

abstract fun getSubscribedUsers(): List<User>

Get a list of currently subscribed User objects.

getTemporaryContentUrlsForMedia

abstract fun getTemporaryContentUrlsForMedia(media: List<Media>, listener: CallbackListener<Map<String, String>>): CancellationToken

Get content URLs for all media attachments in the given set using single network request.

getTemporaryContentUrlsForMediaSids

abstract fun getTemporaryContentUrlsForMediaSids(mediaSids: List<String>, listener: CallbackListener<Map<String, String>>): CancellationToken

Get content URLs for all media attachments in the given set using single network request.

handleNotification

abstract fun handleNotification(notification: NotificationPayload)

Queue the incoming notification with the conversations library for processing.

isReachabilityEnabled

abstract fun isReachabilityEnabled(): Boolean

Get reachability service status.

registerFCMToken

abstract fun registerFCMToken(token: ConversationsClient.FCMToken, listener: StatusListener)

removeAllListeners

abstract fun removeAllListeners()

Method to remove all listeners from this Client.

removeListener

abstract fun removeListener(listener: ConversationsClientListener)

Method to remove listener from this Client.

setLogLevel

open fun setLogLevel(level: ConversationsClient.LogLevel)

Set verbosity level for log messages to be printed to android logcat.

shutdown

abstract fun shutdown()

Cleanly shuts down the messaging client when you are done with it.

unregisterFCMToken

abstract fun unregisterFCMToken(token: ConversationsClient.FCMToken, listener: StatusListener)

Unregister from Firebase Messaging updates.

updateToken

abstract fun updateToken(token: String, listener: StatusListener)

Method to update the authentication token for this client.