How to display the Help Center's services as modules on your flutter apps?
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 important to note that the default configuration of modules may differ depending on the edition of your Zoho Desk account.
The configuration of the help center components is based on your Zoho Desk Help Center settings.
You need to include the relevant code snippets to display the available components in your application.
Home Screen
To display the ASAP SDK home screen, use the following code snippet:
- import 'package:zohodesk_portal_core/zohodesk_portal_core.dart' show ZohodeskPortalCore;
ZohodeskPortalCore.showHome();
Knowledge Base Module
To display the Knowledge Base screen, use the following code snippet:
import 'package:zohodesk_portal_kb/zohodesk_portal_kb.dart' show ZohodeskPortalKb;
ZohodeskPortalKb.show();
Community Module
To display the Community screen, use the following code snippet:
import 'package:zohodesk_portal_community/zohodesk_portal_community.dart' show ZohodeskPortalCommunity;
ZohodeskPortalCommunity.show();
To display the Add Topic screen, use the following code snippet:
import 'package:zohodesk_portal_community/zohodesk_portal_community.dart' show ZohodeskPortalCommunity;
ZohodeskPortalCommunity.showTopicForm();
Tickets Module
To display the Tickets List screen, use the following code snippet:
import 'package:zohodesk_portal_ticket/zohodesk_portal_ticket.dart' show ZohodeskPortalTicket;
ZohodeskPortalTicket.show();
To display the Add Ticket screen, use the following code snippet:
import 'package:zohodesk_portal_ticket/zohodesk_portal_ticket.dart' show ZohodeskPortalSubmitTicket;
ZohodeskPortalSubmitTicket.show();
SalesIQ Chat Module
Chat provides a real-time communication channel for end-users to interact with a customer support agents.
The following method displays the SalesIQ chat module:
import 'package:zohodesk_portal_chat/zohodesk_portal_chat.dart' show ZDPortalChat;
ZDPortalChat.show();
Guided Conversations Module
To display GC or Answer Bot, use the following code snippet:
import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
ZDPortalGC.show();
Code is standard for both iOS and Android platforms.
Session Variables
These
variables are dynamically retrieved during the bot conversations. These
variables are org-specific and accessible across GC flows.
Read more - GC's session variable.
You can perform these actions with the session variable as mentioned:
Set Session Variable:
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
List<Map<String, String>> sessionVariable = [{"name": "YOUR VARIABLE NAME", "value" : "YOUR VARIABLE VALUE"}, {"name": "YOUR VARIABLE NAME", "value": "YOUR VARIABLE VALUE" }];
ZDPortalGC.setGCSessionVariable(sessionVariable);
Update Session Variable:
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
List<Map<String, String>> sessionVariable = [{"name": "YOUR VARIABLE NAME", "value" : "YOUR VARIABLE VALUE"}, {"name": "YOUR VARIABLE NAME", "value": "YOUR VARIABLE VALUE" }];
ZDPortalGC.updateGCSessionVariable(sessionVariable);
Answer Bot Module
Answer Bot helps end-users find answers from a bot trained on the available articles in the portal's KB module.
The following methods display the Answer Bot:
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
ZDPortalGC.showAnswerBot();
Code is standard for both iOS and Android platforms.Business Messaging Module
Business Messaging helps end-users chat with agents directly or with a guided conversation flow.
The following methods display the Business Messaging:
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
ZDPortalGC.showBM();
Code is standard for both iOS and Android platforms.
You can perform these actions with the session variable as mentioned:
Set Session Variables
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
List<Map<String, String>> sessionVariable = [{"name": "YOUR VARIABLE NAME", "value" : "YOUR VARIABLE VALUE"}, {"name": "YOUR VARIABLE NAME", "value": "YOUR VARIABLE VALUE" }];
ZDPortalGC.setBMSessionVariable(sessionVariable);
Update Session Variable:
- import 'package:zohodesk_portal_gc/zohodesk_portal_gc.dart' show ZDPortalGC;
List<Map<String, String>> sessionVariable = [{"name": "YOUR VARIABLE NAME", "value" : "YOUR VARIABLE VALUE"}, {"name": "YOUR VARIABLE NAME", "value": "YOUR VARIABLE VALUE" }];
ZDPortalGC.updateBMSessionVariable(sessionVariable);
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 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?
Zoho DataPrep Resources
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
Working with the ASAP SDK for Flutter
The ASAP SDK provides easy-to-use code snippets that "effortlessly integrate Help Center Components" with your Flutter application, including the following: • Knowledge Base: Provide users with easy access to articles and FAQs, enabling them to find ...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 ...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 ...How to Integrate the ASAP SDK with Flutter Apps
To install the plugin in your project, run either of the below mentioned commands: flutter pub add zohodesk_portal_services (or) add the following in pubspec.yaml dependencies: zohodesk_portal_services: version How to resolve the ASAP SDK ...Setting up the ASAP Help Widget on the Web
Introduction The ASAP help widget for websites makes your help center easily available for your end-customers. By embedding this widget with your website, you can provide your customers with easy access to your: Customer support team (to raise ...
New to Zoho LandingPage?
Zoho LandingPage Resources