AXP Messaging UI/com.avaya.messaging_ui/AvayaMessagingUiSDK

AvayaMessagingUiSDK

object AvayaMessagingUiSDK

Properties

audioRecordingEnabled

var audioRecordingEnabled: Boolean

Set this flag to true if you want to support audio recording

autoDownloadImages

var autoDownloadImages: Boolean

Set this flag to true if you want to automatically download Images

autoDownloadMediaFiles

var autoDownloadMediaFiles: Boolean

Set this flag to true if you want to automatically download Media Files

compressImageBeforeSending

var compressImageBeforeSending: Boolean

Set this flag to true if you want to compress the image before sending

fileSharingEnabled

var fileSharingEnabled: Boolean

Set this flag to true if you want to support file sharing

imageCaptureEnabled

var imageCaptureEnabled: Boolean

Set this flag to true if you want to support image capture through camera

locationSharingEnabled

var locationSharingEnabled: Boolean

Set this flag to true if you want to support location sharing

var mediaSavePath: String?

Directory path where you want to save downloaded media files or will be saved in Downloads folder

showActiveParticipants

var showActiveParticipants: Boolean

Set this flag to true if you want to show the active participants list in the messaging window

showAgentEvents

var showAgentEvents: Boolean

Set this flag to true if you want to show the agent joined and left events in the messaging window

var showAgentName: Boolean

Set this flag to true if you want to show the agent name in the messaging window

showAutomationEvents

var showAutomationEvents: Boolean

Set this flag to true if you want to show the automation events in the messaging window

showIdleTimeoutDialog

var showIdleTimeoutDialog: Boolean

Set this flag to true if you want to show the idle timeout dialog in the messaging window when there is no activity from customer

showTypingParticipantAvatar

var showTypingParticipantAvatar: Boolean

Controls the avatar of the participant is shown in the typing indicator.

showTypingParticipantName

var showTypingParticipantName: Boolean

Controls the display name of the participant is shown in the typing indicator.

typingIndicatorEnabled

var typingIndicatorEnabled: Boolean

Controls the visibility of the typing indicator in the messaging window.

useBusinessAsParticipant

var useBusinessAsParticipant: Boolean

Set this flag to true if you want to use business as participant in the messaging window

videoCaptureEnabled

var videoCaptureEnabled: Boolean

Set this flag to true if you want to support video capture through camera

Functions

getConversationHandler

fun getConversationHandler(conversation: Conversation, context: Context? = null): ConversationHandler

get the conversation handler for the given conversation which should be passed while calling UI function

fun init()

starts observing idle timeout and events stream state / server connection state

isSupportedLocale

fun isSupportedLocale(locale: Locale): Boolean

this function checks if the static strings for given locale is supported by default. Non static strings like date separator supports all locales by default.

setInternetState

fun setInternetState(connected: Boolean)

If you are observing the internet connection state, set internet connection state and it will be reflected in the messaging window

fun setLanguage(locale: Locale, customStrings: CustomStrings? = null)

set the language to the messaging window

setMessagingTheme

fun setMessagingTheme(theme: MessagingThemeConfig)

set the customized theme to the messaging window

setUiEventHandler

fun setUiEventHandler(handler: UiEventHandler)

Register a handler to provide location details and address

fun setUiThemeDark()

set dark theme to messaging window

setUiThemeLight

fun setUiThemeLight()

set light theme to messaging window

supportedLocales

fun supportedLocales(): Set<Locale>

this returns the set of supported locales