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

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

Notes
This SaelsIQ configuration is provided in the ASAP SDK starting from version 4.2.0. In versions below 4.2.0, the preChatForm was disabled by default. From version 4.2.0 onwards, it is enabled by default. Please set your configurations accordingly.
Notes
Once the SalesIQ is successfully initialised. You can proceed with the additional configurations.
Info
For a smooth user experience, ensure that all necessary configurations are applied after initialization

setSalesIQInitCallback

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

Ensure that this callback is set before calling ZohoDeskPortalSDK.getInstance(getApplicationContext()).initDesk(orgId, appId, datacenterValue).

Parameters:

  1. onInitialized - This is called when the SalesIQ SDK is successfully initialised.
  2. onException - This is called when the SDK initialization fails.

Example:

Here is an example of SalesIQ configurations set within the callback.

  1. ZohoDeskPortalSalesIQ.setSalesIQInitCallback(object : SalesIQInitCallback {
  2.     override fun onInitialized() { // On successfully initializing SalesIQ
  3. // ZohoDeskPortalSalesIQ.setChatVisibility(Component.PRECHAT_FORM,true)
  4. // ZohoDeskPortalSalesIQ.setConversationVisibility(true)                  
  5.     }
  6.     override fun onException(p0: Int, p1: String?) { //On Failed
  7.     }
  8.  })

ShowLauncher

The ZohoDeskPortalSalesIQ.setLauncherVisibility(mode: LauncherMode) API allows you to manage the SalesIQ launcher's visibility based on the specified mode.
Parameters of VisibilityMode:
  1. ALWAYS_VISIBLE - The launcher will always be visible.
  2. NEVER_VISIBLE - The launcher will always be hidden.
  3. VISIBLE_WHEN_ACTIVE_CHAT - The launcher will be visible only when there is an active chat.
  1. ZohoDeskPortalSalesIQ.setLauncherVisibility(LauncherMode.ALWAYS_VISIBLE)

enableDragToDismiss

The ZohoDeskPortalSalesIQ.enableDragToDismiss(enable: Boolean) you can close the SalesIQ launcher by dragging it and dropping it onto the close button.
  1. ZohoDeskPortalSalesIQ.enableDragToDismiss(false)

setConversationTitle

This ZohoDeskPortalSalesIQ.setConversationTitle(title: String) API allows you to set the title for the conversations list screen in SalesIQ.
  1. ZohoDeskPortalSalesIQ.setConversationTitle("History")

setConversationVisibility

This ZohoDeskPortalSalesIQ.setConversationVisibility(visible: Boolean) API can be used to enable or disable the visitor conversation history in the salesiQ UI.

Parameters:
  1. true - Displays the conversation screen. (Default) 
  2. false - Hides the conversation screen.
Notes
This API cannot enable conversation history in UI if disabled in portal settings.
  1. ZohoDeskPortalSalesIQ.setConversationVisibility(true)

showFeedbackAfterSkip

The ZohoDeskPortalSalesIQ.showFeedbackAfterSkip(show: Boolean) API allows you to manage the duration of the feedback card for 24 hours after the chat ends.
Parameters:
  1. true - The feedback card will be displayed permanently. (Default)
  2. false - The feedback card will displayed for 24 hours until feedback is given.
Notes
The feedback card will always have the Skip option. When enable is "false" and upon clicking on Skip, the card will not be displayed again until the next chat.
  1. ZohoDeskPortalSalesIQ.showFeedbackAfterSkip(false)

hideQueueTime

The ZohoDeskPortalSalesIQ.hideQueueTime(show:Boolean) API controls the visibility of the chat queue time in the chat window when connecting to an operator. 
Parameter:
  1. true - This hides chat queue time. (Default)
  2. false - This displays the chat Queue Time.
  1. ZohoDeskPortalSalesIQ.hideQueueTime(true)

setLoggerEnabled

This ZohoDeskPortalSalesIQ.setLoggerEnabled(isEnabled:Boolean) API lets you request debug logs for your application from visitors. In the SalesIQ dashboard, you can set the boolvalue to either enable or disable the request app log feature for your operators.

Parameter:
  1. true - Enables the logs.
  2. false - Disables the logs. (Default)
  1. ZohoDeskPortalSalesIQ.setLoggerEnabled(true)

showOfflineMessage

This showOfflineMessage(show: Boolean) API will set an offline banner in the chat window during non-business hours and when agents are busy to help visitors leave a message even when agents are unavailable.

Parameters:
  1. true - Displays the offline message card. (Default) 
  2. false - Hides the offline message card.
  1. ZohoDeskPortalSalesIQ.showOfflineMessage(true)

setKnowledgeBaseVisibility

The ZohoDeskPortalSalesIQ.setKnowledgeBaseVisibility(enable: Boolean) API allows you to manage the resource's visibility in the Mobilisten knowledge base section.
​
Parameters:
true - This will display the resource type. (Default)
false - This will hide the resource type.
Notes
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.
  1. ZohoDeskPortalSalesIQ.setKnowledgeBaseVisibility(true)​

setChatVisibility

This ZohoDeskPortalSalesIQ.setChatVisibility(Component, true) API lets you toggle the function of various components in SalesIQ
NotesThe components' settings are considered only if their function is enabled in portal settings.
  1. ZohoDeskPortalSalesIQ.setChatVisibility(Component.PRECHAT_FORM,true)// Add other configurations as needed...
Parameters:

Chat component

Function description

Default setting

preChatForm

Enable/disable the pre-chat from before initiating a chat.

Enabled

operatorImage

Used to enable/disable the operator's profile image in the chat window.

Enabled

visitorName

This option is used to configure the visibility of the visitor's name for all outgoing messages.

Disabled

screenshot

Used to enable/disable the ability to take screenshots from the add attachments menu.

Enabled

rating

Enable/disable taking photos and videos from the add attachments menu on the chat.

Enabled

feedback

Enable/disable the option to give feedback after a chat has ended.

Enabled

emailTranscript

Enable/disable the option to request an email transcript for a chat.

Enabled

fileshare

Used to enable/disable the option to share files in 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

reopenChat
Used to show/hide the reopen chat button in the chat window.
Enabled

queuePosition

Controls the visibility of the queue position in the chat window. 

Enabled