What are the configuration settings for the ASAP iOS SalesIQ SDK?

The SalesIQ configuration included in the ASAP SDK from version 4.0.6 has some changes. In earlier versions leading up to 4.0.6, the preChatForm was set to disabled by default. However, starting from version 4.0.6, it will now be enabled by default. Please make sure to adjust your configurations accordingly.

To use SalesIQ configurations, import the ZohoDeskPortalSalesIQ module:

import ZohoDeskPortalSalesIQ

setCallbackOnInit

For the SalesIQ configuration, you need to set up all the required configurations using the ZDPortalSalesIQ.setCallbackOnInit method.

Set this callback before the ASAP SDK initialization.

Parameters:

onSuccess - A closure that is called when the SalesIQ SDK is successfully initialised.
onError - A closure that is called when the SDK initialization fails.

Example

An example SalesIQ configuration set within the callback

ZDPortalSalesIQ.setCallbackOnInit (
onSuccess: {// On successfully initializing SalesIQ
//Add SalesIQ configurations here
},
onError: {//On Failed
print("Failed while initilaizing the SalesIQ")
}
)

For additional code snippet examples, refer here.

ShowLauncher

The ZDPortalSalesIQ.showLauncher(_ mode: ZDPSalesIQComponents.VisibilityMode) API allows you to manage the SalesIQ launcher's visibility based on the specified visibility mode.

Parameters of VisibilityMode:

.always - The launcher will always be visible.
.never - The launcher will always be hidden.
.whenActiveChat - The launcher will be visible only when there is an active chat.

ZDPortalSalesIQ.showLauncher(.never)

enableDragToDismiss

The ZDPortalSalesIQ.enableDragToDismiss(_ enable: Bool) allows you to close the SalesIQ launcher by dragging it and dropping it onto the close button.

ZDPortalSalesIQ.enableDragToDismiss(false)

setConversationVisibility

This ZDPortalSalesIQ.setConversationVisibility(_ visible: Bool) API can turn the visitor conversation history on or off in the salesiQ UI.

Parameters:

true - Displays the conversation screen. (Default)
false - Hides the conversation screen.

This API cannot enable conversation history in UI if it is disabled in portal settings.

ZDPortalSalesIQ.setConversationVisibility(true)

setConversationTitle

This ZDPortalSalesIQ.setConversationTitle(_ title: String) API allows you to set the title for the conversations list screen in SalesIQ.

ZDPortalSalesIQ.setConversationTitle("Conversations")

showOfflineMessage

The showOfflineMessage(_ show: Bool) API enables the display of an offline banner in the chat window during non-business hours, allowing visitors to leave a message even when agents are unavailable.

Parameters:

true - Displays the offline message card. (Default)
false - Hides the offline message card.

ZDPortalSalesIQ.showOfflineMessage(true)

setOfflineMessage

This ZDPortalSalesIQ.setOfflineMessage(_ message: String) API allows you to set the offline message in the salesIQ screen.

ZDPortalSalesIQ.setOfflineMessage("Agents are currenlty offline. Please try again later.")

showFeedbackAfterSkip

The ZDPortalSalesIQ.showFeedbackAfterSkip(_ show: Bool) API allows you to manage the duration of the feedback card for 24 hours after the chat ends.

Parameters:

true - The feedback card will be displayed permanently. (Default)
false - The feedback card will displayed for 24 hours until feedback is given.

The feedback card will always have the Skip option. When enabled, it is "false," and the card is clicked on Skip. It will not be displayed again until the next chat.

ZDPortalSalesIQ.showFeedbackAfterSkip(false)

hideQueueTime

The ZDPortalSalesIQ.hideQueueTime(_ show: Bool) API controls the visibility of the chat queue time in the chat window when connecting to an operator.

Parameter:

true - This hides chat queue time. (Default)
false - This displays the chat Queue Time.

ZDPortalSalesIQ.hideQueueTime(true)

setLoggerEnabled

This ZDPortalSalesIQ.setLoggerEnabled(_ enable: Bool) API lets you request your application debug logs from visitors. By setting the bool value, you can enable or disable the request app log feature for your operators in the SalesIQ dashboard.

Parameter:

true - Enables the logs.
false - Disables the logs. (Default)

ZDPortalSalesIQ.setLoggerEnabled(true)

setKnowledgeBaseVisibility

The ZDPortalSalesIQ.setKnowledgeBaseVisibility(_ enable: Bool) API allows you to manage the resource's visibility in the Mobilisten knowledge base section.

Parameters:

true - This will display the resource. (Default)
false - This will hide the resource.

The API will work when "Articles" is enabled under brand settings. To check, navigate to Settings > Brands > Personalisation > Knowledge Base > Article from your SalesIQ dashboard.

ZDPortalSalesIQ.setKnowledgeBaseVisibility(true)

setChatVisibility

This ZDPortalSalesIQ.setChatVisibility(_ component: ZDPSalesIQComponents.ChatComponent, visible: Bool) API lets you toggle the function of various components in SalesIQ.

Example code snippet for setChatVisbility:

ZDPortalSalesIQ.setChatVisibility(.preChatForm, visible: false)

The components' settings are considered only if their function is enabled in the portal settings.

Parameters:

Chat component	Function description	Default setting
preChatForm	Enable/disable the pre-chat from before initiating a chat.	Enabled
attenderImageInChat	Enable/disable the attendee's profile image in the chat window.	Enabled
attenderImageOnLauncher	Enable/disable the ability to display the attender's profile picture on the launcher. (this option is considered only if there is one open chat available)	Disabled
visitorName	This option is used to configure the visibility of the visitor's name for all outgoing messages.	Disabled
fileSharing	Enable/disable the access to send files from the files application in chat.	Enabled
mediaCapture	Enable/disable taking photos and videos from the add attachments menu on the chat.	Enabled
photoLibrary	Enable/disable the option to access the photo library to send images and videos in chat.	Enabled
screenshotOption	Enable/disable the ability to take screenshots from the add attachments menu.	Enabled
inAppNotifications	Enable/disable in-app notifications when a new message is received in chat.	Enabled
emailTranscript	Enable/disable the option to request an email transcript for a chat.	Enabled
rating	Enable/disable the option to rate a chat after it has ended.	Enabled
feedback	Enable/disable the option to give feedback after a chat has ended.	Enabled
reopen	Show or hide the chat reopen option on the chat window.	Enabled
end	Controls the visibility of the end action option in the chat window.	Enabled
endWhenInQueue	Controls the visibility of the end action option in the chat window when the user is in the queue.	Enabled
endWhenBotConnected	Controls the visibility of the end action option in the chat window when the bot is connected.	Enabled
endWhenOperatorConnected	Controls the visibility of the end action option in the chat window when a human operator is connected.	Enabled
queuePosition	Controls the visibility of the queue position in the chat window.	Enabled