The goal of the following document is to enumerate the different fields controlling design attributes in the SDK. If a clearer view of which attribute corresponds with a design element is needed, please utilize the Attributes Design Sheet.

Users Bubble

Name Type Description Example Default
remoteUserBubbleBackgroundColor UIColor Color code for the background of the remote user bubble. remoteuserbubblebackgroundcolor #004DC9
remoteUserBubbleBorderColor UIColor Color code for the outline color. remoteuserbubblebordercolor #004DC9
remoteUserBubbleLinkColor UIColor Color code for links in the text of the remote user bubble. remoteuserbubblelinkcolor UIColor.white
remoteUserBubbleTextColor UIColor Color code for the text of the remote user bubble. remoteuserbubbletextcolor UIColor.white
remoteUserBubbleBorderWidth Double Double number for the outline width. remoteuserbubbleborderwidth 2
remoteUserBubbleTimestampColor UIColor Color code for the timestamp of the remote user bubble. remoteuserbubbletimestampcolor #5B5C5E
remoteUserTypingTintColor UIColor Color of the remote user typing bubbles animation. remoteusertypingtintcolor UIColor.white
remoteUserBubbleLongPressOverlayColor UIColor Color of the remote user's bubble overlay when user uses a long press gesture on the bubble. Overlay will appear as long as the menu controller appears on the bubble. When the menu dismissed, overlay will disappear too. In order to show overlay, enableBubblesOverlayOnLongPress should be true. remoteUserBubbleOverlay UIColor.black
remoteUserBubbleLongPressOverlayAlpha Float Alpha of the remote user's bubble overlay when user uses a long press gesture on the bubble. Value can be 0.0 - 1.0. Overlay will appear as long as the menu controller appears on the bubble. When the menu is dismissed, overlay will disappear too. In order to show overlay, enableBubblesOverlayOnLongPress should be true. remoteUserBubbleOverlay 0.3
remoteUserBubbleTopLeftCornerRadius Float Top left Radius corner on the Remote bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. remoteTopLeft 8
remoteUserBubbleTopRightCornerRadius Float Top right Radius corner on the Remote bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. remoteTopRight 8
remoteUserBubbleBottomLeftCornerRadius Float Bottom left Radius corner on the Remote bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. remoteBottomLeft 8
remoteUserBubbleBottomRightCornerRadius Float Bottom right Radius corner on the Remote bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. remoteBottomRight 8
userBubbleBackgroundColor UIColor Color code for the background of the visitor bubble. userbubblebackgroundcolor #EDEDED
userBubbleBorderColor UIColor Color code for the outline color. userbubblebordercolor #EDEDED
userBubbleLinkColor UIColor Color code for links in the text of the visitor bubble. userbubblelinkcolor #0000ee
userBubbleTextColor UIColor Color code for the text of the visitor bubble. userbubbletextcolor UIColor.black
userBubbleBorderWidth Double Double number for the outline width. userbubbleborderwidth 1
userBubbleTimestampColor UIColor Color code for the timestamp of the visitor bubble. userbubbletimestampcolor #5B5C5E
userBubbleSendStatusTextColor UIColor Color code for the send status text of the visitor bubble. userbubblesendstatustextcolor #5B5C5E
userBubbleErrorTextColor UIColor Color code for the error view text of the visitor bubble. userbubbleerrortextcolor #DE0A23
userBubbleErrorBorderColor UIColor Color code for the error view border of the visitor bubble. userbubbleerrorbordercolor #DE0A23
userBubbleLongPressOverlayColor UIColor Color of the user bubble's overlay when user uses a long press gesture on the bubble. Overlay will appear as long as the menu controller appears on the bubble. When the menu is dismissed, overlay will disappear too. In order to show overlay, enableBubblesOverlayOnLongPress should be true. userBubbleOverlay UIColor.black
userBubbleLongPressOverlayAlpha Float Alpha of the user's bubble overlay when user use long press gesture on the bubble. Value can be 0.0 - 1.0. Overlay will appear as long as the menu controller appears on the bubble, when the menu dismissed, overlay will disappear too. In order to show overlay enableBubblesOverlayOnLongPress should be true. userBubbleOverlay 0.3
userBubbleTopLeftCornerRadius Float Top left Radius corner on the User bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. userTopLeft 8
userBubbleTopRightCornerRadius Float Top right Radius corner on the User bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. userTopRight 8
userBubbleBottomLeftCornerRadius Float Bottom left Radius corner on the User bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. userBottomLeft 8
userBubbleBottomRightCornerRadius Float Bottom right Radius corner on the User bubble. Setting the radius to a value greater than 0.0 causes the bubble's layer to begin drawing rounded corners on its background. This attribute affects the bubble's masking and it's recommended to use a corner radius which is at max equals to half of the bubble's height. Setting a corner radius larger than half of the bubble's height will cause text to cut visually. userBottomRight 8
bubbleEmailLinksRegex String? Regular expression for email hyperlinks in users messages (consumer and agent). This attribute is optional - If not assigned, the default link detection will be enabled nil
bubbleUrlLinksRegex String? Regular expression for url hyperlinks in users messages (consumer and agent). This attribute is optional - If not assigned, the default link detection will be enabled nil
bubblePhoneLinksRegex String? Regular expression for phone hyperlinks in users messages (consumer and agent). This attribute is optional - If not assigned, the default link detection will be enabled nil
bubbleTopPadding Float Define the bubble Top Padding bubbleTopPadding 10
bubbleBottomPadding Float Define the bubble bottom Padding bubbleBottomPadding 10
bubbleLeadingPadding Float Define the bubble Leading Padding bubbleLeadingPadding 10
bubbleTrailingPadding Float Define the bubble Trailing Padding bubbleTrailingPadding 10
bubbleTimestampBottomPadding Float Define the bubble Trailing Padding bubbleTimestampBottomPadding 5
bubbleTimestampTopPadding Float Define the bubble Timestamp Top Padding bubbleTimestampTopPadding 5
enableEnlargeEmojis Bool When true, user and remote user messages containing one or two emojis will be enlarged in chat. Messages with one emoji will be the largest, two emojis will be large, and 3 or more will be displayed as normal text. enableEnlargeEmojis false
Name Type Description Example Default
enableLinkPreview Bool Enable or disable link preview feature. If disabled, user will not see site's link preview or link preview. true
linkPreviewBackgroundColor UIColor Color code for the background of the link preview area inside cell. UIColor.white
linkPreviewTitleTextColor UIColor Color code for the title text inside link preview area inside cell. UIColor.black
linkPreviewDescriptionTextColor UIColor Color code for the description text inside link preview area inside cell. #5B5C5E
linkPreviewSiteNameTextColor UIColor Color code for the description site name link preview area inside cell. #E2E3E3
linkPreviewBorderWidth Double Double number for the outline width of link preview area inside cell. 1.0
linkPreviewStyle LPUrlPreviewStyle Refers to the style in which the link preview cell will be displayed Slim: linkpreviewslim
Large: linkpreviewlarge
LPUrlPreviewStyle.slim
linkPreviewSiteNameTextColor UIColor Color code for the description site name link preview area inside cell.
urlRealTimePreviewBackgroundColor UIColor The background color of the url real time preview realtimepreviewbackgroundcolor UIColor.white
urlRealTimePreviewBorderColor UIColor The border color of the url real time preview realtimepreviewbordercolor
urlRealTimePreviewBorderWidth Float The border width of the url real time preview urlRealTimePreviewBorderWidth
urlRealTimePreviewTitleTextColor UIColor The title text color of the url real time preview urlRealTimePreviewTitleTextColor
urlRealTimePreviewDescriptionTextColor UIColor The description text color of the url real time preview urlrealtimepreviewdescriptiontextcolor
useNonOGTagsForLinkPreview Bool urlPreview will also use non og tags to parse urls instead of using only og tags if useNonOGTagsForLinkPreview is true true

Photo Sharing

Name Type Description Example Default
enablePhotoSharing Bool True - Enables Photo Sharing feature, False - Disables Photo Sharing false
maxNumberOfSavedFilesOnDisk Int This number represents how many files will be saved on the disk. Exceeding files are deleted when the app closes. 20
photosharingMenuBackgroundColor UIColor Photo Sharing menu background color photosharingmenubackgroundcolor #0362AC
photosharingMenuButtonsBackgroundColor UIColor Photo Sharing menu buttons background color photosharingmenubuttonsbackgroundcolor UIColor.white
photosharingMenuButtonsTintColor UIColor Photo Sharing menu buttons tint color photosharingmenubuttonstintcolor #0362AC
photosharingMenuButtonsTextColor UIColor Photo Sharing menu buttons text color photosharingmenubuttonstextcolor UIColor.white
cameraButtonEnabledColor UIColor Photo Sharing Camera button color in enabled mode in the conversation screen. Will be presented only if photo sharing feature is enabled cameraButtonColor #0362AC
cameraButtonDisabledColor UIColor Photo Sharing Camera button color in disabled mode in the conversation screen. Will be presented only if photo sharing feature is enabled cameraButtonColor #8B8A8F
fileCellLoaderFillColor UIColor Radial loader fill color fileCellLoaderFillColor UIColor(white: 0.0, alpha: 0.5)
fileCellLoaderRingProgressColor UIColor Radial loader progress color filecellloaderringprogresscolor UIColor.white
fileCellLoaderRingBackgroundColor UIColor Radial loader progress background color filecellloaderringprogresscolor UIColor.lightGray
Note: Camera button, in the input text view, disabled/enabled color will change according to sendButtonDisabledTextColor and sendButtonEnabledTextColor configurations.

Send Button

Name Type Description Example Default
sendButtonDisabledColor UIColor Color code for Send and Camera (of Photo Sharing) buttons in disabled mode #AAAAAA
sendButtonEnabledColor UIColor Color code for Send and Camera (of Photo Sharing) buttons in disabled mode. #0362AC
sendButtonImage UIImage Send button Image in the conversation screen. The custom image will be changed only if isSendMessageButtonInTextMode = false. the send button image need to follow the Custom Icon documention (https://developer.apple.com/ios/human-interface-guidelines/icons-and-images/custom-icons/) DefaultSendButton SDK bundle sendMessageIcon Icon
isSendMessageButtonInTextMode Bool Two options for send message button mode:Send message button in "text mode" - will be taken from localized resources Send message button in "icon mode" Default mode is text

System Messages

Name Type Description Example Default
systemBubbleTextColor UIColor Color code for the text of the system messages. systemBubbleTextColor UIColor.black

Window Mode

Name Type Description Example Default
customButtonImage UIImage In window mode only: Custom button icon image. This will be displayed on the navigation bar. When the button is pressed, a dedicated callback will be invoked. (See LPMessagingSDKCustomButtonTapped for more information). custombuttonimage nil

Delivery Notifications

Name Type Description Example Default
checkmarkVisibility CheckmarksState(Integer Enum) Checkmark visibility of the following options (type CheckmarksState): SentOnly - Show checkmarks for only Sent messages. SentAndAccepted - Show checkmarks for only Sent and Accepted messages. All - Show checkmarks for Sent, Accepted and Read messages. CheckmarksState.All
checkmarkReadColor UIColor Color of checkmark indication signs of Read messages. checkmarkreadcolor #004DC9
checkmarkDistributedColor UIColor Color of checkmark indication signs of Distributed messages. checkmarkdistributedcolor #5B5C5E
checkmarkSentColor UIColor Color of checkmark indication signs of Sent messages. #5B5C5E
isReadReceiptTextMode Bool Two options for read indication: Read Receipt with Text Mode Read. Receipt with Icon Mode. If the parameter set as true the mode will be Text. If the parameter set as false the mode will be Icon. Default value is true. isReadReceiptTextMode true
messageStatusNumericTimestampOnly Bool When false (default), time stamps will display information relative to when sent/distributed/read (e.g. 'sent 5 minutes ago'. When true, will show as numeric only (e.g. '11:32'). messageStatusNumericTimestampOnly true

Surveys Buttons (CSAT and FCR)

Name Type Description Example Default
csatSubmitButtonCornerRadius Double Corner radius of the Submit button. csatSubmitButtonCornerRadius 30
csatYesNoButtonsCornerRadius Double Corner radius of the resolution Yes/No buttons. csatYesNoButtonsCornerRadius 25
csatSubmitButtonBackgroundColor UIColor Background color code of the Submit button. csatsubmitbuttonbackgroundcolor #229A49
csatSubmitButtonTextColor UIColor Text color code of the Submit button. csatSubmitButtonTextColor UIColor.white
csatRatingButtonSelectedColor UIColor Background Color code of the rating buttons. csatRatingButtonSelectedColor #229A49
csatResolutionButtonSelectedColor UIColor Color code for the FCR survey buttons (YES/NO) when selected. csatresolutionbuttonselectedcolor #229A49
csatAllTitlesTextColor UIColor Title text color for all labels. csatAllTitlesTextColor UIColor.black
csatResolutionHidden Bool Hides the FCR survey (YES/NO) question. csatResolutionHidden false
csatAgentViewHidden Bool Hides the view of agent avatar and name. csatagentviewhidden true
csatThankYouScreenHidden Bool Hides the Thank You screen after tapping Submit button. csatthankyouscreenhidden false
csatNavigationBackgroundColor UIColor Background color of the navigation of the survey. csatnavigationbackgroundcolor #229A49
csatNavigationTitleColor UIColor Text color of the title in the survey navigation. UIColor.white
csatSkipButtonColor UIColor Skip survey button color. UIColor.black
csatUIStatusBarStyleLightContent Bool Allow the UI status bar to take the color of the survey navigation bar color. true
csatShowSurveyView Bool Hides the whole survey view and disables it. true
csatSurveyExpirationInMinutes UInt Expiration of CSAT in minutes from the moment the conversation was ended. If Survey exceeded the expiration, it will not be presented to the user. Default 24H 1440

Conversations

Name Type Description Example Default
maxPreviousConversationToPresent UInt Number of conversations to show in advance. 2
deleteClosedConversationOlderThanMonths UInt Upon SDK initialization, all closed conversations with an end date older than X months will be deleted from the database. Setting 0 will delete all closed conversations. 13
sendingMessageTimeoutInMinutes UInt Maximum number of minutes to send the message 60
conversationSeparatorTextColor UIColor Conversation separator text and line color conversationseparatortextcolor UIColor.black
enableConversationSeparatorTextMessage Bool Toggle conversation separator text message when conversation resolved from agent or consumer conversationseparatortextcolor true
enableConversationSeparatorLine Bool Toggle conversation separator line when conversation resolved from agent or consumer conversationseparatortextcolor true
conversationSeparatorFontSize UIFontTextStyle Define the conversation closed separator font size conversationClosedSeparatorFontSize UIFontTextStyle.caption1
conversationSeparatorBottomPadding Float Define the conversation Closed label to separator line padding conversationClosedSeparatorBottomPadding 7
conversationSeparatorFontName Float Custom font name for conversation closed separator. Fonts that are not part of the iOS families, must be defined in App's Info.plist conversationClosedSeparatorFontName 7
conversationSeparatorViewBottomPadding String Define the conversation separator view bottom padding conversationClosedSeparatorViewBottomPadding nil
conversationClosedSeparatorTopPadding Float Define the conversation Closed Separator Top padding conversationClosedSeparatorTopPadding 5
enableVibrationOnMessageFromRemoteUser Bool Toggle vibration sound when a new message from a remote user received false
announceAgentTyping Bool If true, show agent is typing indicator in selected position and accessibility will announce when agent is typing a message to the consumer. If false, will not show any indication, and will not announce when agent is typing a message. true
showAgentTypingInMessageBubble Bool if true, shows agent is typing indicator in a message bubble. If false, show indicator under Agent label in navigator bar. if announceAgentTyping is false, will not show any "is typing" indicator regardless of current value. true

Unread Messages

Name Type Description Example Default
scrollToBottomButtonBackgroundColor UIColor Scroll to bottom button background color of the whole button scrolltobottombuttonarrowcolor UIColor.black
scrollToBottomButtonMessagePreviewTextColor UIColor Scroll to bottom button text color of the last unread message preview scrolltobottombuttonmessagepreviewtextcolor UIColor.white
scrollToBottomButtonBadgeBackgroundColor UIColor Scroll to bottom button unread message badge background color scrolltobottombuttonbadgebackgroundcolor #E7242D
scrollToBottomButtonBadgeTextColor UIColor Scroll to bottom button unread message badge text color scrolltobottombuttonbadgetextcolor UIColor.white
scrollToBottomButtonArrowColor UIColor Scroll to bottom button arrow tint color scrolltobottombuttonarrowcolor UIColor.white
unreadMessagesDividerBackgroundColor UIColor Unread Messages divider background color unreadmessagesdividerbackgroundcolor #F5F5F5
unreadMessagesDividerTextColor UIColor Unread Messages divider text color unreadmessagesdividertextcolor #004DC9
scrollToBottomButtonEnabled Bool Toggle the mode of the Scroll to bottom button true
scrollToBottomButtonMessagePreviewEnabled Bool Toggle the mode of the Scroll to bottom unread message text preview true
unreadMessagesDividerEnabled Bool Toggle the mode of the Unread Messages divider. If disabled, scroll to bottom button will scroll to bottom although we can have new messages and don't show the badge at all nor "new message preview" true
unreadMessagesCornersRadius Float Define the corners radius of the unread messages bubble. unreadBubbleRadius 8 for all the corners
scrollToBottomButtonCornerRadius Float Define the left top and the left bottom corners radius of the scroll down indicator. scrollToBottomButtonCornerRadius 20 for left top and the left bottom the corners
scrollToBottomButtonBadgeCornerRadius Float Define the corners radius of the unread messages counter inside the scroll down indicator. scrollToBottomButtonBadgeCornerRadius 12 for all the corners

Localization

Name Type Description Example Default
country String? Country code: When it is not nil, it will be combined with 'language' ("language_country", for example: en_US) and used instead of device default locale when formatting date and time. If no value is provided, the SDK will use the country according to the device's locale. nil
language LPLanguage Language that will be used instead of default device language. Its type is LPLanguage enum that contains all the languages that are supported by MessagingSDK. It will affect the following areas: 1. Will be used when getting localized strings 2. Will be combined with 'country' ("language_country", for example: en_US) and used instead of default device locale when formatting time and date. If no value is provided, the SDK will use the device's language as default. DeviceLanguage

Brand

Name Type Description Example Default
brandName String The brand name will be shown as a title on toolbar when there is no active conversation. "" (Empty String)
conversationBackgroundColor UIColor Color code for the entire view background. UIColor.white
customFontNameConversationFeed String? Custom font name for conversation feed. This font will affect all Messages, Timestamp and Separators. Fonts that are not part of the iOS families, must be defined in App's Info.plist customFontNameConversationFeed nil
customFontNameNonConversationFeed String? Custom font name for all non conversation feed controls. Such as: Buttons, Alerts, Banners, Menu and External Windows. Fonts that are not part of the iOS families, must be defined in App's Info.plist customFontNameNonConversationFeed nil
customRefreshControllerImagesArray <ArrayUIImage>? Array of images for creating the custom refresh controller the controller will loop the images from the array need two or more images in the array for take effect customRefreshControllerImagesArray nil
customRefreshControllerAnimationSpeed Float<UIImage> custom refresh controller speed animation define the full images loop time. Smaller value will create high speed animation 2
conversationBackgroundPortraitImage UIImage; When not nil, will be used as the conversation portrait background image. When an image is shown it is recommended to set dateSeparatorBackgroundColor config to clear. nil
conversationBackgroundLandscapeImage UIImage; When not nil, will be used as the conversation landscape background image. When an image is shown it is recommended to set dateSeparatorBackgroundColor config to clear. nil
conversationBackgroundImageContentMode UIViewContentMode; Defines the content mode of the conversation background image. scaleToFill

Date Separator

Name Type Description Example Default
dateSeparatorTitleBackgroundColor UIColor Color code for date separator title background color. dateseparatortitlebackground UIColor.white
dateSeparatorTextColor UIColor Color code for date separator text color. dateSeparatorTextColor #46474A
dateSeparatorLineBackgroundColor UIColor Color code for date separator line background color. datesepartaorlinebackgroundcolor UIColor.clear
dateSeparatorBackgroundColor UIColor Color code for date separator background color. dateSeparatorBackgroundColor #FFFFFF
dateSeparatorFontSize UIFontTextStyle Define the Date Separator font text style. dateSeparatorFontSize UIFontTextStyle.footnote
customFontNameDateSeparator String Custom font name for Timestamp. Fonts that are not part of the iOS families, must be defined in App's Info.plist. customFontNameSeparatorTimestampFeed nil
dateSeparatorTopPadding Float Define the Date Separator Top padding. dateSeparatorTopPadding 0
dateSeparatorBottomPadding Float Define the Date Separator bottom padding. dateSeparatorBottomPadding 0

User input view

Name Type Description Example Default
inputTextViewContainerBackgroundColor UIColor User Input TextView container background color. inputTextViewContainerBackgroundColor #F5F5F5
inputTextViewCornerRadius Double User Input TextView corner radius. inputtextviewcornerradius 20.0

Agent Assignment

Name Type Description Example Default
retrieveAssignedAgentFromLastClosedConversation Bool When using "getAssignedAgent" method, this option lets you decide whether to get assigned agents from active conversations only, or also from the last closed conversation in case there is no active conversation. If not assigned agent is available this method will return nil. true

Duration of Local Notifications

Name Type Description Example Default
notificationShowDurationInSeconds Double Display duration of the local notification in seconds. Examples: TimeToRespond notification, local notification, etc. Note: this parameter will be extended to 60sec when in VoiceOver mode. 3 (60 when in VoiceOver mode)

Time To Response and Off hours

Name Type Description Example Default
ttrShouldShow Bool Toggling this on will show TTR notifications including off hours. When the auto messages feature is enabled, TTR notifications will not be displayed regardless of this parameter.’) true
ttrShowShiftBanner Bool Ability to enable/disable shift toaster ('An agent will respond...’) true
ttrFirstTimeDelay Double TTR - Time To Respond. Number of seconds before the first TTR notification appears. 10
ttrShouldShowTimestamp Bool TTR - Time To Respond. Enable: Displays a time stamp in the TTR notification. Disable: Displays: "An agent will respond shortly". ttrShouldShowTimestamp
ttrShouldShowTimestamp
false
ttrShowFrequencyInSeconds UInt Controls the TTR frequency: Don’t show the TTR more than once in X seconds. 8
showUrgentButtonInTTRNotification Bool TTR - Time To Respond. Enable presentation of Urgent button in the TTR notification. showUrgentButtonInTTRNotification
showurgentbuttoninttrnotification
false
showOffHoursBanner Bool Ability to disable/enable the off-hours toaster. showoffhoursbanner true
ttrBannerBackgroundColor UIColor Color of background for banner. ttrBannerBackgroundColor #52A742
ttrBannerTextColor UIColor Text color of the banner. ttrbannertextcolor #52A742
ttrBannerOpacityAlpha Double Opacity level of the banner background (values: 0.0 - 1.0). ttrBannerOpacityAlpha 0.8
offHoursTimeZoneName String Off Hours time zone name string based on [NSTimeZone knownTimeZoneNames]. If sending empty string, the local timezone will be used (Server sends UTC time). ""

Date and Time

Name Type Description Example Default
lpDateFormat String? Custom formatting for date string (day, year..), for example: 'd MMM'. If not defined, one of the default styles will be used (see timestamps formatting). nil
lpTimeFormat String? Custom formatting for time string (hours, lpDateTimeFormat minutes..), for example: 'hh:mm a'. If not defined, one of the default styles will be used (see timestamps formatting). nil
lpDateTimeFormat String? Custom formatting for date and time string, for example: 'EEEE MM/dd/YY hh:mm a'. If not defined, one of the default styles will be used (see timestamps formatting). nil

Toast Notifications

Name Type Description Example Default
toastNotificationsEnabled Bool Enable toast notifications such as offline and TTR notifications. False: Disable toast notifications. true
csdsDomain String CSDS Domain URL. For brands that need to control the URL that is the gateway for LivePerson services, use this key to set a URL of your choice. "https://adminlogin.liveperson.net/csdr/account/%@/service/baseURI.json?version=1.0"

User Avatar

Name Type Description Example Default
remoteUserAvatarBackgroundColor UIColor Background color of the remote user’s avatar. #004DC9
remoteUserAvatarLeading Float Define the remote avatar Leading padding (left edge to avatar). remoteUserAvatarLeadingPadding 8
remoteUserAvatarTrailingPadding Float Define the remote avatar Trailing padding (Avatar to bubble). remoteUserAvatarTrailingPadding 8
remoteUserAvatarIconColor UIColor Icon color of default remoteUser avatar. #0362AC #FFFFFF
remoteUserDefaultAvatarImage UIImage? Default Avatar image of the remote user. When assigned, this image will disable remoteUserAvatarBackgroundColor and remoteUserAvatarIconColor configurations. If remote user has an avatar image in his profile, this attribute will be ignored. nil
brandAvatarImage UIImage? Set avatar image for brand. This is an optional UIImage that if is set to nil a default avatar will be presented. Image ratio should be 1:1 (square) and at least 50x50 pixels. nil
csatAgentAvatarBackgroundColor UIColor Background color of agent's default avatar in CSAT. csatAgentAvatarBackgroundColor #004DC9
csatAgentAvatarIconColor UIColor Icon color of agent's default avatar in CSAT. csatAgentAvatarIconColor #FFFFFF

Data Masking

Name Type Description Example Default
enableClientOnlyMasking Bool Determines whether to enable using regular expression to control which part of the text to mask, all masked data will appear as asterisks, will be saved to local db masked and will be sent to the server unmasked. false
enableRealTimeMasking Bool Determines whether to enable using regular expression to control which part of the text to mask, all masked data will appear as asterisks, will be saved to local db masked and sent to the server masked. false
clientOnlyMaskingRegex String Regular expression string to control which part of the text to mask, all masked data will appear as asterisks, will be saved to local db masked and will be sent to the server unmasked. Default is empty, meaning no regex. The regular expression patterns and behavior are based on Perl's regular expressions. See Apple Reference. ""
realTimeMaskingRegex String Regular expression string to control which part of the text to mask. All masked data will appear as asterisks, will be saved to local db masked, and will be sent to the server masked. Default is empty, meaning no regex. The regular expression patterns and behavior are based on Perl's regular expressions. See Apple Reference. ""
Name Type Description Example Default
conversationNavigationBackgroundColor UIColor Background color of navigation bar in conversation screen. #0362AC
conversationNavigationTitleColor UIColor Navigation title color in conversation screen. #FFFFFF
conversationStatusBarStyle UIStatusBarStyle Status bar style in conversation screen. .LightContent

Secure Form

Name Type Description Example Default
secureFormBackButtonColor UIColor Back button color in secure form screen UIColor.black
secureFormUIStatusBarStyleLightContent Bool Should display status bar of the secure form screen in Light Content Mode (UIStatusBarStyle) true
secureFormNavigationBackgroundColor UIColor Background color of navigation bar in secure form screen #0362AC
secureFormNavigationTitleColor UIColor Navigation title color in secure form screen UIColor.white
secureFormBubbleBackgroundColor UIColor Secure form bubble background color UIColor.white
secureFormBubbleBorderColor UIColor Secure form bubble border color #d4d4d5
secureFormBubbleBorderWidth Double Secure form bubble border width in pixels 2.0
secureFormBubbleTitleColor UIColor Secure form bubble form title color UIColor.black
secureFormBubbleDescriptionColor UIColor Secure form bubble fill form text button color #5b5c5e
secureFormBubbleFillFormButtonTextColor UIColor Secure form bubble fill form text button color #004dc9
secureFormBubbleFillFormButtonBackgroundColor UIColor Secure form bubble fill form button background color UIColor.clear
secureFormBubbleFormImageTintColor UIColor Secure form bubble form image tint color #004dc9
secureFormCustomFontName String Secure form custom font name to be used while user is filling the secure form. If not set, the default font will be Helvetica. secureFormCustomFontName Helvetica
secureFormHideLogo Bool Secure form flag for hiding the secure form logo in the top of the form. secureFormHideLogo false
secureFormBubbleLoadingIndicatorColor UIColor Secure form loading indicator color while loading form before opening. secureFormBubbleLoadingIndicatorColor #46474a

Structured Content

Name Type Description Example Default
enableStrucutredContent Bool Enable or Disable toggle for Structured Content feature in conversations false
structuredContentBubbleBorderWidth Double Structured Content bubble border width in pixels. 0.3
structuredContentBubbleBorderColor UIColor Structured Content bubble border color. nil
structuredContentBubbleTopLeftCornerRadius Float Structured Content bubble top left corner radius in pixels. 0.0
structuredContentBubbleTopRightCornerRadius Float Structured Content bubble top right corner radius in pixels. 0.0
structuredContentBubbleBottomLeftCornerRadius Float Structured Content bubble bottom left corner radius in pixels. 0.0
structuredContentBubbleBottomRightCornerRadius Float Structured Content bubble bottom right corner radius in pixels. 0.0
structuredContentMapLatitudeDeltaDeltaSpan Double Structured Content Latitude Delta Span. Used to determine which area of the map to focus on. If you set this attribute, you must set structuredContentMapLongitudeDeltaSpan as well. This parameter is used to create an MKCoordinateSpan. For more info, click here. 0.01
structuredContentMapLongitudeDeltaSpan Double Structured Content Longitude Delta Span. Used to determine which area of the map to focus on. If you set this attribute, you must set structuredContentMapLatitudeDeltaDeltaSpan as well. This parameter is used to create an MKCoordinateSpan. For more info, click here. 0.01

Quick Reply

Name Type Description Example Default
quickReplyButtonVerticalPadding CGFloat Distance between the bottom and top edges of the button to the bottom and top edges of the text 10.0
quickReplyButtonHorizontalPadding CGFloat Distance between the right and left edges of the button to the right and left edges of the text 15.0
quickReplyVerticalPadding CGFloat Vertical padding between quick reply buttons 10.0
quickReplyHorizontalPadding CGFloat Horizontal padding between quick reply buttons 10.0
quickReplyButtonBorderWidth CGFloat Border size of Quick Reply buttons 1.0

Connection Status Bar

Name Type Description Example Default
connectionStatusConnectingBackgroundColor UIColor Color code for the background of the connection status bar while connecting. systemBubbleTextColor #f5f5f5f2
connectionStatusConnectingTextColor UIColor Color code for the text of the connection status bar while connecting. systemBubbleTextColor #46474a
connectionStatusFailedToConnectBackgroundColor UIColor Color code for the background of the connection status bar when connection failed. systemBubbleTextColor #000000cc
connectionStatusFailedToConnectTextColor UIColor Color code for the text of the connection status bar when connection failed. systemBubbleTextColor UIColor.white

Controller message

Name Type Description Example Default
controllerBubbleTextColor UIColor Color code for the text of the controller bubble. controller bubble text color #5b5c5e

Audio support

Name Type Description Example Default
recordingDurationLimit TimeInterval (Double) Maximum time frame for recording audio message (in seconds). 120
enableAudioSharing Bool True - Enables Audio Sharing feature, False - Disables Audio Sharing false
maxNumberOfSavedAudioFilesOnDisk Int This number represents how many audio files will be saved on the disk. Exceeding files are deleted when the app closes. 20