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

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

Notes
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:
  1. import ZohoDeskPortalSalesIQ

setCallbackOnInit

For the SalesIQ configuration, you need to set up all the required configurations using the ZDPortalSalesIQ.setCallbackOnInit method.
Notes
Set this callback before the ASAP SDK initialization.
Parameters:
  1. onSuccess - A closure that is called when the SalesIQ SDK is successfully initialised.
  2. onError - A closure that is called when the SDK initialization fails.
Example

An example SalesIQ configuration set within the callback
  1. ZDPortalSalesIQ.setCallbackOnInit (
  2. onSuccess: {// On successfully initializing SalesIQ
  3.      //Add SalesIQ configurations here
  4.     },
  5.     onError: {//On Failed
  6.          print("Failed while initilaizing the SalesIQ")
  7. }
  8. )
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:
  1. .always - The launcher will always be visible.
  2. .never - The launcher will always be hidden.
  3. .whenActiveChat - The launcher will be visible only when there is an active chat.
  1. 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.
  1. ZDPortalSalesIQ.enableDragToDismiss(false)

setConversationVisibility

This ZDPortalSalesIQ.setConversationVisibility(_ visible: Bool) API can turn the visitor conversation history on or off 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 it is disabled in portal settings.
  1. ZDPortalSalesIQ.setConversationVisibility(true)

setConversationTitle

This ZDPortalSalesIQ.setConversationTitle(_ title: String) API allows you to set the title for the conversations list screen in SalesIQ.
  1. 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:
  1. true - Displays the offline message card. (Default) 
  2. false - Hides the offline message card.
  1. ZDPortalSalesIQ.showOfflineMessage(true)

setOfflineMessage

This ZDPortalSalesIQ.setOfflineMessage(_ message: String) API allows you to set the offline message in the salesIQ screen.
  1. 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:
  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 enabled, it is "false," and the card is clicked on Skip. It will not be displayed again until the next chat.
  1. 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:
  1. true - This hides chat queue time. (Default)
  2. false - This displays the chat Queue Time.
  1. 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:
  1. true - Enables the logs.
  2. false - Disables the logs. (Default)
  1. 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:
  1. true - This will display the resource. (Default)
  2. false - This will hide the resource.
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. 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:
  1. ZDPortalSalesIQ.setChatVisibility(.preChatForm, visible: false)
Notes

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


      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 FormsRetailOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceForms for Solopreneurs
                              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
                              Forms for Government
                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic FormsInsurance
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsWufoo alternativeEncrypted Forms
                              Accessible FormsTypeform 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

                                                                  Use cases

                                                                  Make the most of Zoho Desk with the use cases.

                                                                   
                                                                    

                                                                  eBooks

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

                                                                   
                                                                    

                                                                  Videos

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

                                                                   
                                                                    

                                                                  Webinar

                                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                                   
                                                                    
                                                                  • Desk Community Learning Series


                                                                  • Meetups


                                                                  • Ask the Experts


                                                                  • Kbase


                                                                  • Resources


                                                                  • Glossary


                                                                  • Desk Marketplace


                                                                  • MVP Corner



                                                                    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 iOS 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 ...
                                                                                                                            • 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 ...
                                                                                                                            • 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 change your language settings for ASAP Flutter SDK?

                                                                                                                              The ASAP SDK is designed to accommodate a diverse user base, supporting a total of 49 languages. This flexibility allows you to select the most suitable language based on the geographical location of your app's end-users, ensuring a tailored ...
                                                                                                                            • 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 ...
                                                                                                                              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