What are the configuration settings for the ASAP SalesIQ Flutter SDK?
To display details of anonymous users in the chat module to your agents:
When an anonymous user contacts the customer support agent via the SalesIQ Chat, their details usually do not appear on the agent's screen. However, you can configure the ASAP help widget to display these details after receiving them from the concerned user.
To configure this setting, use the following method:
- import 'package:zohodesk_portal_siq/zohodesk_portal_siq.dart';
- void setGuestUserDetails() {
- ZohodeskPortalSiq.setGuestUserDetails("John Doe", "johndoe@example.com", "+1234567890");
- }
Additionally, agents can convert chat conversations into tickets if additional user interactions are required later. The email address is a mandatory parameter for such a conversion.To use SalesIQ configurations, import the ZohoDeskPortalSalesIQ module:
- import 'package:zohodesk_portal_siq/zohodesk_portal_siq.dart';
This SalesIQ configuration is provided in the ASAP SDK starting from version 2.1.0. In versions below 2.1.0, the preChatForm was disabled by default. From version 2.1.0 onwards, it is enabled by default. Please set your configuration preferences accordingly.After successfully initializing SalesIQ, you can proceed with the additional configurations.
For a smooth user experience, ensure that all necessary configurations are applied after initialization.
setSalesIQInitCallback
For SalesIQ configuration, you need to set up all the required configurations in SalesIQInitCallback.onInitialized block of the Init Callback.
Ensure that SalesIQ Init callback is set before calling ZohodeskPortalApikit.initializeSDK(orgId, appId, datacenterValue);
Parameters:
onException - This is called when the SDK initialization fails.
Example
Here is the example SalesIQ configurations set within the callback:
- import 'package:zohodesk_portal_siq/common/SalesIQInitCallback.dart';
- import 'package:zohodesk_portal_siq/zohodesk_portal_siq.dart';
- class InitCallback implements SalesIQInitCallback{
- @override
- void onException( String? errorMessage) {
- //SalesIQ Init Failure
- }
- @override
- void onInitialized() {
- //SalesIQ Init Success
- }
- }
- void setInitCallback() {
- ZohodeskPortalSiq.setSalesIQInitCallback(InitCallback());
- }
setLauncherVisibility
The ZohodeskPortalSiq.setLauncherVisibility(LauncherMode) API allows you to manage the visibility of the SalesIQ launcher based on the specified launcher mode.
Parameters of LauncherMode:
NEVER_VISIBLE - The launcher will always be hidden.
VISIBLE_WHEN_ACTIVE_CHAT - The launcher will be visible only when there is an active chat.
- import 'package:zohodesk_portal_siq/common/LauncherMode.dart';
- import 'package:zohodesk_portal_siq/zohodesk_portal_siq.dart';
- void setLauncherVisibility() {
- ZohodeskPortalSiq.setLauncherVisibility(LauncherMode.NEVER_VISIBLE);
- }
enableDragToDismiss
The ZohodeskPortalSiq.enableDragToDismiss(Boolean) allows closing the SalesIQ launcher by dragging and dropping it on the close button.
- ZohodeskPortalSiq.enableDragToDismiss(true);
setConversationTitle
This ZohoDeskPortalSalesIQ.setConversationTitle(String) API allows you to set the title for the conversations list screen in SalesIQ.
- ZohodeskPortalSiq.setConversationTitle("Set conversation title here");
setConversationVisibility
This ZohoDeskPortalSalesIQ.setConversationVisibility(Boolean) API can be used to enable or disable the visitor conversation history in the salesIQ UI.
Parameters:
true - Displays the conversation screen (default).false - Hides the conversation screen.
This API cannot be used to enable the conversation history on the UI if it is disabled in the portal settings.
- ZohodeskPortalSiq.setConversationVisibility(true);
showFeedbackAfterSkip
The ZohoDeskPortalSalesIQ.showFeedbackAfterSkip(Boolean) API allows you to manage the duration of the feedback card for 24 hours after the chat ends.
Parameters:
enable:true - The feedback card will be displayed permanently (default).
false - The feedback card will be displayed for 24 hours until feedback is given.
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.
- ZohodeskPortalSiq.showFeedbackAfterSkip(false);
hideQueueTime
The ZohoDeskPortalSalesIQ.hideQueueTime(Boolean) 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.
- ZohodeskPortalSiq.hideQueueTime(true);
setLoggerEnabled
This setLoggerEnabled( Boolean ) lets you request your application debug logs from the visitor. By setting the boolean value, you can choose to 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).
- ZohodeskPortalSiq.setLoggerEnabled(true);
showOfflineMessage
This showOfflineMessage( 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:
true - Displays the offline message card (default).false - Hides the offline message card.
- ZohodeskPortalSiq.showOfflineMessage(true);
setKnowledgeBaseVisibility
The ZohodeskPortalSiq.setKnowledgeBaseVisibility(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.
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. - ZohodeskPortalSiq.setKnowledgeBaseVisibility(true);
setChatVisibility
This ZohodeskPortalSiq.setChatVisibility(chatComponents, true) API lets you toggle the function of various components in SalesIQ.
The components' settings are considered only if their function is enabled in portal settings.
Parameter of ChatComponent:
Chat component | Function description | Default setting |
PRECHAT_FORM | Enable/disable the pre-chat form before initiating a chat. | Enabled |
OPERATOR_IMAGE | Enable/disable the attendee's profile image in the chat window. | Enabled |
| VISITOR_NAME | This option is used to configure the visibility of the visitor's name for all outgoing messages. | Disabled |
SCREENSHOT | Enable/disable the ability to take screenshots from the adding attachments menu. | 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 |
EMAIL_TRANSCRIPT | Enable/disable the option to request an email transcript for a chat. | Enabled |
FILE_SHARE | Enable/disable the access to send files from the files application in chat. | Enabled |
END | Controls the visibility of the end action option in the chat window. | Enabled |
END_WHEN_BOT_CONNECTED | Show/hide the end chat option only for the bot-connected chats. | Enabled |
END_WHEN_OPERATOR_CONNECTED | Controls the visibility of the end action option in the chat window when a human operator is connected. | Enabled |
END_WHEN_IN_QUEUE | Controls the visibility of the end action option in the chat window when the user is in the queue. | Enabled |
QUEUE_POSITION | Controls the visibility of the queue position in the chat window. | Enabled |
REOPEN | Show/hide the reopen chat button in the chat window. | Enabled |
- import 'package:zohodesk_portal_siq/common/ChatComponent.dart';
- import 'package:zohodesk_portal_siq/zohodesk_portal_siq.dart';
- void setChatVisibility() {
- ZohodeskPortalSiq.setChatVisibility(ChatComponent.PRECHAT_FORM, true);// Add other configurations as needed...
- }
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 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 Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
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 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 ...Working with the ASAP SDK for Flutter
This document pertains explicitly to help widgets created using the updated new ASAP Setup. If you use an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ASAP Flutter Plugin 2.0. ...ASAP SDK Flutter Apps - Release Notes
2.2.2 Removed deprecated packages associated with Android v1 embedding to ensure compatibility with the latest Flutter versions. 2.2.1 Integrated the ASAP iOS SDK v4.2.0 2.2.0 Integrated the ASAP Android SDK v4.4.1 Integrated the ASAP iOS SDK v4.1.2 ...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 ...
New to Zoho LandingPage?
Zoho LandingPage Resources