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 important to note that the default configuration of modules may differ depending on the edition of your Zoho Desk account.
To display the SDK Dashboard
The SDK dashboard is the screen through which end-users access your help center services. This dashboard displays icons or buttons that provide access to your Knowledge Base, Community Forums, Support Team (through the ticket submission form), tickets list (a list of tickets submitted by users who are logged in), and Chat (to interact with a customer support agent in real-time).
The SDK UI does not default to enabling the Chat module. You must first enable it on your Zoho Desk portal.
Include the following code in your chosen method to display the SDK dashboard:
- ZDPortalHome.show(MainActivity.this);
To display the SDK Dashboard with overridden configuration
I Display selected modules in the SDK dashboard
The SDK enables you to embed your preferred help center services as modules in your application, excluding the other modules.
By default, the modules will be shown based on the portal's and module's configuration. If we need to override those settings on the Android app alone, we can use the following method.
By default, the modules will be shown based on the portal's and module's configuration. If we need to override those settings on the Android app alone, we can use the following method.
The following method displays the SDK dashboard with its configuration overridden:
ZDPHomeConfiguration config = new ZDPHomeConfiguration.Builder()
.isKBEnabled(true)
.isCommunityEnabled(true)
.isLiveChatEnabled(true)
.isMyTicketsEnabled(true).build();
ZDPortalHome.setConfiguration(config);
ZDPortalHome.show(activity);
II Display individual modules without displaying the SDK dashboard
You also have the option to provide access to individual help center services as modules without displaying the SDK dashboard on your application.
The following methods help you display the individual modules with their default configuration:
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 Chat module:
- ZohoDeskPortalSalesIQ.show(activity);
activity is the activity instance that triggers the Chat module.
Knowledge Base Module
The Knowledge Base module enables end-users to access through help articles.
The following method display the Knowledge Base:
- ZDPortalKB.show(activity);
activity is the activity instance that triggers the Knowledge Base module.
Submit Tickets
Submit Ticket is the screen through which end-users can submit their questions/requests as support tickets. It allows support agents to view, track, prioritize, and respond to customer tickets in one place.
The following methods display the Submit Ticket screen.
- ZDPortalSubmitTicket.show(activity);
activity is the activity instance that triggers the Submit Ticket module.
My Tickets
My Tickets is the screen through which end-users can access, track, and edit their submitted tickets.
The following method display the My Tickets screen.
- ZDPortalTickets.show(activity);
activity is the activity instance that triggers the My Tickets module.
User Community Module
User Community is the module through which end-users can access discussion forums and interact with other users to share knowledge.
The following method displays the User Community:
- ZDPortalCommunity.show(activity);
activity is the activity instance that triggers the User Community module.
Guided Conversations Module
Guided Conversations helps end-users find answers themselves or perform a standard process without an agent's assistance by following a pre-built conversation flow.
The following methods display the Guided Conversations:
- ZohoDeskPortalChatKit.showGC(activity);
activity is the activity instance that triggers the Guided Conversations module.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:
- val sessionVariables = arrayListOf(
hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
)
ZohoDeskPortalChatKit.setGCSessionVariable(this, sessionVariables)
Update Session Variable:
- val sessionVariables = arrayListOf(
hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
)
ZohoDeskPortalChatKit.updateGCSessionVariable(this, sessionVariables)
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:
- ZohoDeskPortalChatKit.showAnswerBot(activity);
activity is the activity instance that triggers the Answer Bot module.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:
- ZohoDeskPortalChatKit.showBM(activity);
activity is the activity instance that triggers the Business Messenger module.
Set Session Variables
You can perform these actions with the session variable as mentioned:
- val sessionVariables = arrayListOf(
hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
)
ZohoDeskPortalChatKit.setBMSessionVariable(this, sessionVariables)
Update Session Variable:
- val sessionVariables = arrayListOf(
hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
)
ZohoDeskPortalChatKit.updateBMSessionVariable(this, sessionVariables)
Set the Contact
The following methods will set the contact in Business Messaging:
- ZohoDeskPortalChatKit.setBMContactInfo
- (context, "userName", "mobileNo", "emailAdd", addInfo)
- context = Application Context
- userName = Name of the user
- mobileNo = Mobile number of the User
- emailAdd = Email address of the user.
- addInfo = HashMap<String, String>
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?
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
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 ...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 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 ...How to install an ASAP Help Widget
The ASAP (App Support Across Platforms) help widget in Zoho Desk is a stand-alone application that provides users with an in-app self-service platform. It works in tandem with your business and allows you to to integrate help center features directly ...ASAP SDK Android - Release Notes
4.3.0 Updated the compileSDKVersion and targetSDKVersion to 35. Updated the Gradle plugin version to 8.2.2. Supported edge-to-edge UI for apps targeting Android 15. Supported voice-to-search feature in Global Search screens. 4.2.0 Implemented the ...
New to Zoho LandingPage?
Zoho LandingPage Resources