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

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit

                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              WCAG



                                        Create. Review. Publish.

                                        Write, edit, collaborate on, and publish documents to different content management platforms.

                                        Get Started Now







                                                          You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                              Manage your brands on social media


                                                                • Desk Community Learning Series


                                                                • Digest


                                                                • Functions


                                                                • Meetups


                                                                • Kbase


                                                                • Resources


                                                                • Glossary


                                                                • Desk Marketplace


                                                                • MVP Corner


                                                                • Word of the Day


                                                                • Ask the Experts


                                                                  Zoho Sheet Resources

                                                                   

                                                                      Zoho Forms Resources


                                                                        Secure your business
                                                                        communication with Zoho Mail


                                                                        Mail on the move with
                                                                        Zoho Mail mobile application

                                                                          Stay on top of your schedule
                                                                          at all times


                                                                          Carry your calendar with you
                                                                          Anytime, anywhere




                                                                                Zoho Sign Resources

                                                                                  Sign, Paperless!

                                                                                  Sign and send business documents on the go!

                                                                                  Get Started Now




                                                                                          Zoho TeamInbox Resources





                                                                                                    Zoho DataPrep Demo

                                                                                                    Get a personalized demo or POC

                                                                                                    REGISTER NOW


                                                                                                      Design. Discuss. Deliver.

                                                                                                      Create visually engaging stories with Zoho Show.

                                                                                                      Get Started Now









                                                                                                                          • Related Articles

                                                                                                                          • Introducing ASAP Android SDK

                                                                                                                            This document pertains explicitly to help widgets created using the updated new ASAP Setup. Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your app, use the latest ...
                                                                                                                          • How to Integrate the ASAP SDK with React Native

                                                                                                                            After successfully setting up the ASAP SDK on your mobile application, the next step is to integrate it. Code block to installing the react-native plugin: We have the following list of plugins, customers can integrate the SDK based on their ...
                                                                                                                          • How to display the Help Center's services as modules on your Android app?

                                                                                                                            In this help article, we will learn how to display the individual help center services as modules on the ASAP help Widget. The modules can be viewed based on their default configuration and the settings configured in your Zoho Desk portal. It's ...
                                                                                                                          • What are the configuration settings for the ASAP Flutter SDK?

                                                                                                                            ASAP configuration The ASAP SDK offers methods to show or hide specific features. For example, you can hide the Knowledge Base (KB) module by using the following method: import ...
                                                                                                                          • What are the configuration settings for the ASAP Android SDK?

                                                                                                                            ASAP configuration ASAP SDK provides methods to display/hide specific functionality. For example, To hide the Knowledge Base (KB), use the following method: ZDPortalConfiguration.setConfiguration(new ...
                                                                                                                            Wherever you are is as good as
                                                                                                                            your workplace

                                                                                                                              Resources

                                                                                                                              Videos

                                                                                                                              Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                              eBooks

                                                                                                                              Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                              Webinars

                                                                                                                              Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                              CRM Tips

                                                                                                                              Make the most of Zoho CRM with these useful tips.



                                                                                                                                Zoho Show Resources