🚧

Note

Please note that we have announced end of sale for Android UI SDK. It is no longer offered as a standard Webex Connect capability.

The Webex Connect UI SDK for Android builds on the message transport capabilities exposed within the Core SDK through a collection of customizable user interface components. These components may be used to easily integrate a fully-featured rich messaging capability within a host application.

This document serves as a reference and details all of the public classes, interfaces, and methods.

New Classes and APIs are added to UI SDK to support message transport capabilities within the Core SDK through a collection of customizable user interface components

The details of all of the public classes, interfaces, and methods are available in the sections that follow. Also, see the Quick Start Guide.

Packages

The following table lists all the packages along with their descriptions:

com.imimobile.connect.ui

imiconnectUI

This class handles the initialization of the SDK.

startup

This method initializes the SDK for use. This variant must be called to initialize the SDK before any other features may be used.

  Syntax: void startup(android.content.Context context, ICUIConfig config, ICUIStartupCallback callback)

  Parameters:

📘

Note:

When using download at runtime Emoji support, you should always implement the callback and use UI components until startup is complete.

shutdown

This method provides a means to shut down the SDK and performs cleanup, after this method is called, none of the SDK features will work

  Syntax: void shutdown(com.imimobile.connect.core.callbacks.ICShutdownCallback callback)

  Parameters:

isStarted

This method is used to verify whether the SDK has started or not.

  Syntax: boolean isStarted()

Return value: Returns a value to indicate whether the SDK is started or not.

getSDKVersion

This method is used to retrieves/check the SDK build version.

  Syntax: String getSDKVersion()

Return value: Returns the SDK build version.

ICUIConfig

This class represents the methods for SDK configuration.

ICUIConfig (Constructor)

This method is used to initialize an ICUIConfig instance with a fileProviderAuthority.

  Syntax: ICUIConfig(@NonNull String fileProviderAuthority)

  Parameters:

isDownloadEmoji

This method is used to verify the download Emoji value, true or false.

Syntax: boolean isDownloadEmoji()

Return value: Returns true if Emoji download is true, false otherwise.

setDownloadEmoji

This method is used to set the download Emoji value.

  Syntax: void setDownloadEmoji(boolean downloadEmoji)

  Parameters:

getFileProviderAuthority

This method returns FileProviderAuthority.

  Syntax: String getFileProviderAuthority()

Return value: Returns the FileProviderAuthority.

ICMessageViewStyle

This class provides style attributes that are utilized by ICInboxRecyclerView and ICConversationRecyclerView for customization of individual message view components.

setBackgroundResource

This method sets the message background resource id.

  Syntax: void setBackgroundResource(int resId)

  Parameters:

setTextColor

This method sets the message text color.

  Syntax: void setTextColor(int color)

  Parameters:

setTextLinkColor

This method sets the message text link color.

  Syntax: void setTextLinkColor(int textLinkColor)

  Parameters:

setTextSize

This method sets the message text size.

  Syntax: void setTextSize(float size)

  Parameters:

setTextTypeface

This method sets the message text typeface.

  Syntax: void setTextTypeface(Typeface typeface)

  Parameters:

setMargin

This method sets the message margin.

  Syntax: void setMargin(int left, int right)
Parameters:

setGravity

This method sets the message gravity.

  Syntax: void setGravity(int gravity)

  Parameters:

getGravity

This method sets the message gravity.

  Syntax: getGravity()

  Return value: Returns gravity for message.

getBackgroundResource

This method is used to get the Background resource Id for the message.

  Syntax: int getBackgroundResource()

  Returns value: Returns background resource Id for the message.

getTextColor

This method is used to get the text color for the message.

  Syntax: int getTextColor()

  Return value: Returns the message text color value in the form of 0xAARRGGBB.

getTextLinkColor

This method is used to get the Text link color for the message.

  Syntax: int getTextLinkColor()

  Return value: Return message text link color value in the form of 0xAARRGGBB

getTextSize

This method is used to get the Text Size for the message.

  Syntax: float getTextSize()

  Return value: returns text size for Message

getTextTypeface

This method is used to get the Text typeface for message.

  Syntax: Typeface getTextTypeface()

  Return value: Returns text typeface for Message. Must be one of the following constant values monospace(3),normal(0),sans(1),serif (2)

getMarginLeft

This method is used to get the margin Left for the message.

  Syntax: int getMarginLeft()

  Return value: Returns margin left value for message

getMarginRight

This method is used to get the margin-right for the message.

  Syntax: int getMarginLeft()

  Return value: Returns margin right value for message

getCornerRadius

This method is used to get the Corner radius for the message.

  Syntax: int getCornerRadius()

  Return value: Returns Corner radius value for message

setCornerRadius

This method set the Corner radius value

  Syntax: int getCornerRadius()

  Parameters:

getBackgroundColor

This method is used to get the background color for the message.

  Syntax: getBackgroundColor()

  Return value:** Returns background color for message

setBackgroundColor

This method sets the background color for the message.

  Syntax: void setBackgroundColor(int backgroundColor)

  Parameters:

getTimeTextSize

This method is used to get the Time Text size for the message.

  Syntax: int getTimeTextSize()

  Return value: Returns Time Text size value for message

setTimeTextSize

This method sets Time Text size for the message

  Syntax: void setTimeTextSize(int timeTextSize)

  Parameters:

getTimeTextColor

This method is used to get the Time Text Color for the message.

  Syntax: int getTimeTextColor()

  Return value: Returns Time Text Color value for message in the form of 0xAARRGGBB

setTimeTextColor

This method sets the Time Text color for message.

  Syntax: void setTimeTextColor(int timeTextColor)

  Parameters:

getAvatarWidth

Syntax: public int getAvatarWidth()

This method used to get the Avatar width

Returns : Avatar width

getAvatarHeight

Syntax: public int getAvatarHeight()

This method used to get the Avatar Height

Returns : Avatar Height

setAvatarSize

Syntax: public void setAvatarSize(int width, int height)

This method used to set the Avatar width and Height

Parameters:

getAvatarScaleType

Syntax: public ImageView.ScaleType getAvatarScaleType()

This method used to get the Avatar scaleType

Returns : Avatar scale type

setAvatarScaleType

Syntax: public void setAvatarScaleType(ImageView.ScaleType scaleType)

This method used to set the Avatar image scale type

Parameters: scaleType - avatar scale Type

ICMessageRecyclerView

This class has the responsibility to obtain its data through ICMessageDataProvider and uses ICMessageViewHolder instances to display the data.

createMessageAdapter

This method is used to create a message Adapter instance.

Syntax: protected ICMessageRecyclerView.MessageAdapter createMessageAdapter()
Return value: returns message adapter

init

This method is used to Initialize the message recycler View

Syntax: protected void init()

setMessageMenuHandler

This method sets an object which implements ICMessageMenuHandler interface to listen menu build and menu Item click callbacks

Syntax: void setMessageMenuHandler(ICMessageRecyclerView.ICMessageMenuHandler menuBuilder)

Parameters:

createPopupMenu

protected android.support.v7.widget.PopupMenu createPopupMenu(int adapterPosition,

ICMessageViewHolder holder)

registerMessageClickListener

public void registerMessageClickListener(ICMessageRecyclerView.ICMessageClickListener)

This method allows registering an object which implements the
ICMessageClickListener interface to listen for Message click listener.

Parameters:

listener - message click Listener

unregisterMessageClickListener

public void unregisterMessageClickListener(ICMessageRecyclerView.ICMessageClickListener)

This method allows unregistering a previously registered object which implements
the ICMessageClickListener interface, to stop listening for Message
click listener.

Parameters:

listener - message click Listener

setAdapter

public void setAdapter(android.support.v7.widget.RecyclerView.Adapter adapter)

Overrides:

setAdapter in class android.support.v7.widget.RecyclerView

onVisibilityChanged

protected void onVisibilityChanged(View changedView,

int visibility)

Automatically refresh on resume

Overrides:

onVisibilityChanged in class View

refresh

public void refresh()

This method refreshes this adapter based on data set changed

registerPartViewFactories

public void registerPartViewFactories(ICMessagePartViewFactory[] factories)

This method register partView factories to be handled by this message Recycler
View

Parameters:

factories - Array of partView factories to be registered

unregisterPartViewFactories

public void unregisterPartViewFactories(ICMessagePartViewFactory[] factories)

This method unregister partView factories for this message Recycler View

Parameters:

factories - Array of partView factories to be registered

setMessageProvider

public void setMessageProvider(T provider) throws ICException

This method sets message provider which implements ICMessageDataProvider

Parameters:

provider - message data provider

Throws:

com.imimobile.connect.core.exception.ICException

getMessageProvider

public T getMessageProvider()

This method returns message data provider

Return:

returns the message data provider

setMessageViewFactory

public void setMessageViewFactory(ICMessageViewFactory<[V]> factory)

This method sets Message View factory object which inherits from
ICMessageViewFactory

Parameters:

factory – messageViewFactory

setMessageViewStyle - Deprecated

public void setMessageViewStyle(ICMessageViewStyle myStyle, ICMessageViewStyle theirStyle)

This method sets message view styles for my Messages and Their Messages

Parameters:

myStyle - my message style

theirStyle - their Message style

setUnreadMessageViewStyle - Deprecated

public void setUnreadMessageViewStyle(ICMessageViewStyle unreadStyle)

This method sets message view style for unRead Messages

Parameters:

unreadStyle - unRead message style

setAlertMessageViewStyle - Deprecated

public void setAlertMessageViewStyle(ICMessageViewStyle style)

This method sets alert message view style

Parameters:

style - Alert Message style

setAvatars

public void setAvatars(Bitmap myAvatar, Bitmap theirAvatar)

This method set an avatar for my Message and Their Message

Parameters:

myAvatar - avatar for my message

theirAvatar - avatar for their message

getMyMessageViewStyle - Deprecated

protected ICMessageViewStyle getMyMessageViewStyle()

This method returns my message view style

Return:

returns my message view style

getTheirMessageViewStyle - Deprecated

protected ICMessageViewStyle getTheirMessageViewStyle()

This method returns its message view style.

Return:

returns their message view style

getUnreadMessageViewStyle - Deprecated

protected ICMessageViewStyle getUnreadMessageViewStyle()

This method returns the unread message view style.

Return:

returns Unread message view style

getAlertMessageViewStyle - Deprecated

protected ICMessageViewStyle getAlertMessageViewStyle()

This method returns the alert message view style.

Return:

returns Alert message view style

ICMessageViewHolder

This abstract class binds the ICMessageData and applies the ICMessageViewStyle to message views.

bindAvatar

This method binds the avatar to the message view holder.

  Syntax: void bindAvatar(Bitmap avatar)

  Parameters:

bindMessage

This method binds message parts to the respective message part view holder.

  Syntax: void bindMessage(ICMessageData messageData, ICMessagePart[] messageParts)
Parameters:

setMessageViewStyle

This method sets the message view style to message view holder.

  Syntax: void setMessageViewStyle(ICMessageViewStyle style)

  Parameters:

getPartContainerViewHolder

This method returns the message part container view holder.

  Syntax: abstract ICMessagePartContainerViewHolder getPartContainerViewHolder()

  Return value: Returns message part container view holder

getPartContainerViewHolder

This method returns the message view holder.

  Syntax: android.view.View getView()

  Return value: Returns a view object for message view holder.

ICMessageViewFactory

This factory has the responsibility to create all the message views that will be displayed in the conversation.

getMessageGroupHeaderViewType

This method used to get message Group Header View type

  Syntax: long getMessageGroupHeaderViewType(ICMessageGroup group)

  Parameters:

  Return value: Returns message Group Header View type

createMessageGroupHeaderView

This method is used to create the message group header view holder.

  Syntax: abstract ICMessageGroupHeaderViewHolder createMessageGroupHeaderView(android.view.ViewGroup parent, long viewType)

  Parameters:

  Return value: Returns Message group Header View holder object.

getMessageViewIdentifier

This method is used to get the message view identifier based on message parts and factory map.

  Syntax: getMessageViewIdentifier(ICMessageData messageData, ICMessagePart[] messageParts, java.util.Map<String,ICMessagePartViewFactory> factoryMap)

  Parameters:

  Return value: Returns the message Group Header View type.

createMessageView

This method is used to create a message view holder.

  Syntax: createMessageView(android.view.ViewGroup parent, String identifier, java.util.List<ICMessagePartViewFactory> factoryList)

  Parameters:

  Return value: Returns created message view holder.

createPartViews

This method is used to create part views. Message part views are added to the message part container view holder.

  Syntax: createPartViews(ICMessageViewHolder<T> messageViewHolder, String identifier,java.util.List<ICMessagePartViewFactory> factoryList)

  Parameters:

ICMessageViewFactory

Syntax: public ICMessageViewFactory(Context context)

Parameters : context – A valid application context

ICMessageGroupHeaderViewHolder

This class binds message group details into the message group view.

bindMessageGroup

This method binds message group details.

  Syntax: void bindMessageGroup(ICMessageGroup messageGroup)

  Parameters:

getView

This method returns the message group header view.

  Syntax: View getView()

  Return value: Returns message group view.

ICMessageDataProvider

This class provides an interface to obtain message data for displaying it in ICMessageViewHolder instances.

getMessageGroup

This abstract method is used to get the message group.

  Syntax: abstract ICMessageGroup getMessageGroup(int position)

  Parameters:

  Return value: Returns message group view.

getMessageCount

This abstract method is used to get the message count from the message data provider.

  Syntax: abstract int getMessageCount()

  Return value: Returns the message count from message data provider.

getMessageData

This abstract method is used to get message data details from message data provider

  Syntax: abstract ICMessageData getMessageData(int position)

  Parameters:

  Return value: Returns MessageData details from the message data provider.

getMessageParts

This method is used to get message parts from message details passed.

  Syntax: ICMessagePart[] getMessageParts(ICMessageData message)

  Parameters:

  Return value: Returns array of message parts from message data.

deleteMessage

This method deletes the message from the data provider based on the position.

  Syntax: abstract boolean deleteMessage(int position)

  Parameters:

  Return value: Returns true if message deletion is successful , false otherwise.

notifyDataSetChanged

This method notifies any registered observers that the data set has changed.

  Syntax: void notifyDataSetChanged()

registerObserver

This method allows registering an object that implements the ICDataSetObserver interface to listen for dataset changes in the message data provider.

  Syntax: registerObserver(ICDataSetObserver observer)

  Parameters:

unregisterObserver

This method allows unregistering a previously registered object which implements the ICDataSetObserver interface, in order to stop listening for DataSet changes in the Message data provider.

  Syntax: unregisterObserver(ICDataSetObserver observer)

  Parameters:

ICMessageRecyclerView.ICMessageClickListener

This interface defines a callback to be invoked when a message view is clicked.

onMessageClick

This method will be invoked when the message click event happened

  Syntax: `boolean onMessageClick(int position)``

  Return value: Returns True if the listener has consumed the message click event, false otherwise.

onMessageLongClick

This method is invoked when the message long-click event occurs.

  Syntax: `boolean onMessageLongClick(int position)``

  Return value: True if the listener has consumed the message long-click event, false otherwise.

ICMessageRecyclerView.ICMessageMenuHandler

This interface definition to be invoked to listen menu build and menu item click callbacks.

onBuildMenu

This method is used to callback upon pop-up menu build.

  Syntax: PopupMenu onBuildMenu(android.support.v7.widget.PopupMenu popupMenu,int adapterPosition,android.view.View anchor)

  Return value: Returns a pop-up menu.

onMenuItemClick

This method is invoked when a menu item is clicked.

  Syntax: boolean onMenuItemClick(MenuItem menuItem)

com.imimobile.connect.ui.conversation

ICConversationActivity

This activity leverages the functionality of the lower-level components and provides necessary wiring to combine them into a fully-featured in-app chat experience with minimal code.

The activity supports the display of the user conversation list and provides a means to open them or create new conversations. Select a conversation to display the conversation view and allow users to read, compose, and send messages.

Prerequisites

This component requires that a valid ICMessageStore instance is set within the Core SDK by calling ICMessaging.setMessageStore.

Modes of Operation

Depending on how the activity is started, there are two distinct modes of operation. Each mode is provided to cover different usage scenarios.

The standard mode of operation presents the conversation listing and allows the user to open an existing conversation or create a new one.

Alternatively, the activity may be started to display a specific conversation directly. This is useful when you need to take your user directly to a specific conversation. Perhaps they have navigated to another area within your application, or even to another application, starting with a conversation id allows you to take your user back to the conversation.

Adaptive Layout

The layout of the activity adapts to the device display, typically when running on a phone the activity will display the conversation list full screen when a conversation is displayed this replaces the conversation list display. Navigating back from the conversation will cause the conversation list to be re-displayed.

When running on a wide layout (greater than 700dp in landscape), the layout is split into two sections. The conversation list is shown on the left and the active conversation is shown on the right.

Launching the Activity

The activity provides two helper methods to start the activity in each of the supported modes of operation.

Start

This method starts the activity to display a specific conversation.

  Syntax: void start(Context context, String conversationId, Bundle extArgs)

  Parameters:

Starts the activity to display a list of conversations.

  Syntax: void start(Context context, ArrayList<ICConversationCategory> categories,ICCustomerDetails customerDetails, Bundle extArgs)

  Parameters:

Styling

The activity may be customized to match the look and feel of your application. This is accomplished by setting styling attributes via XML.

To style the activity you must first declare styles that inherit from the default styles provided by the SDK and specify these custom styles within your app theme. Internally, the activity leverages the ICConversationsFragment and ICConversationFragment. Refer to their styling sections for further information.

ICConversationCategory

Organizations typically have multiple contact points to which a customer might be directed depending on the query. Conversation categories provide the means to drive users to the correct contact point.

The information contained in an ICConversationCategory instance is also used to establish the correct communication stream for a conversation. Within Webex Connect, real-time messages are sent over a stream. The stream is used to direct messages to the correct service to process the message.

Properties

Constructors

Methods

getImageUri

This method is used to get uri to an image representing the category, which must be a local uri.

  Syntax: `android.net.Uri getImageUri()``

  Return Value: Returns a uri to an image representing the category, which must be a local uri.

setImageUri

This method is used to get uri to an image representing the category, which must be a local uri.

  Syntax: android.net.Uri getImageUri()

ICConversationCategoryRecyclerView

Style attributes

ICQuickReplyViewStyle

Style attributes

ICFormPartViewStyle

Style attributes

ICFormMultiSelectDialogStyle

Style attributes

ICGenericTemplatePartViewStyle

Style attributes

ICGenericTemplateElementViewStyle

Style attributes

ICGenericTemplateElementDetailsStyle

Style attributes