How to display the Help Center's services as modules on your iOS 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 centre 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 Help Center ASAP supports Chat modules such as Guided conversations, Answer Bot, Business Messaging, and SalesIQ.
• If you want to display the Chat module (one of the available ASAP services), ensure it is enabled on the Zoho Desk web portal.
• You can hide a module on the dashboard and launch it from a different location in your app.
• You can also display the SDK dashboard on your app while providing access to individual help modules.
• You can hide a module on the dashboard and launch it from a different location in your app.
• You can also display the SDK dashboard on your app while providing access to individual help modules.
To display the SDK dashboard, include the following code in any method you choose:
Swift
- import ZohoDeskPortalCore
...
ZDPortalHome.show()
Objective-C
- @import ZohoDeskPortalCore;
...
[ZDPortalHome showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
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, all the support modules are enabled. You can disable a particular support module by passing the value "false."
The following method displays the SDK dashboard with its configuration overridden:
Swift
- let config = ZDPHomeConfiguration()
config.enableHelpCenter = true
config.enableCommunity = true
config.enableCreateTicket = true
config.enableMyTicket = true
config.enableAddTopic = true
config.showChat = true
config.showGC = true
config.showAnswerBot = true
config.showBM = true
ZDPortalHome.updateConfiguration(with: config)
ZDPortalHome.show()
Objective-C
- ZDPHomeConfiguration * config = [[ZDPHomeConfiguration alloc]init];
config.enableHelpCenter = YES;
config.enableCommunity = YES;
config.enableCreateTicket = YES;
config.enableMyTicket = YES;
config.enableAddTopic = YES;
config.showChat = YES;
config.showGC = YES;
config.showAnswerBot = YES;
config.showBM = YES;
[ZDPortalHome updateConfigurationWith:config];
[ZDPortalHome showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
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.
Knowledge Base Module
The Knowledge Base module enables end-users to access through help articles.
(i) Include the following import statement for all method calls related to the Knowledge Base:
Swift
- import ZohoDeskPortalKB
Objective-C
- @import ZohoDeskPortalKB;
(ii) The following methods display the Knowledge Base:
Swift
- ZDPortakKB.show()
Objective-C
- [ZDPortalKB showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
(iii) To display a Knowledge Base category using its permalink, use the following method:
Swift
- ZDPortalKB.showCategory(withPermalink: <#String#>)
Objective-C
- [ZDPortalKB showCategoryWithPermalink:<#(NSString * _Nonnull)#> withTitle:<#(NSString * _Nullable)#>];
Permalink refers to the URL of the Knowledge Base category.
For
example, in the URL in the image above, the portion following "/kb/" is
the category's permalink. You can pass this portion as the path of the
category or sub-category.
(iv) To display an article directly using its permalink, use the following method:
Swift
- ZDPortalKB.showArticle(withPermalink : <#String#>)
Objective-C
- [[ZDPortalKB showArticleWithPermalink:<#(NSString * _Nonnull)#> withTitle:<#(NSString * _Nullable)#>];
Permalink refers to the URL of the Knowledge Base category.
For example, in the URL in the image above, the portion following "/articles/" is the article's permalink.
Tickets Module
The ticket module in Zoho Desk manages all customer support requests or inquiries. Each Ticket includes the customer's name, email, phone number, and issue. The ticket module also offers automated ticket assignment, escalation, and SLA management to help support teams streamline their workflow and efficiently support their customers.
Include the following import statement for all method calls related to the Tickets module:
Swift
- import ZohoDeskPortalTicket
Objective-C
- @import ZohoDeskPortalTicket;
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:
Swift
- ZDPortalSubmitTicket.show()
Objective-C
- [ZDPortalSubmitTicket showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
My Tickets
My Tickets is the screen through which end-users can access, track, and edit their submitted tickets.
The following methods display the My Tickets screen:
Swift
- ZDPortalTicket.show()
Objective-C
- [ZDPortalTicket showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
User Community Module
User Community is the module through which end-users can access discussion forums and interact with other users to share knowledge.
(i) Include the following import statement for all method calls related to the community module:
Swift
- import ZohoDeskPortalCommunity
Objective-C
@import ZohoDeskPortalCommunity;
(ii) To display the User's Community
Swift
ZDPortalCommunity.show()
Objective-C
- [ZDPortalCommunity showWithTitle:<#(NSString * _Nullable)#> navigationMode:<#(enum ZDPNavigationMode)#>];
(iii) To display a particular topic
Swift
ZDPortalCommunity.showTopic(withID: <#String#>)
Objective-C
- [ZDPortalCommunity showTopicWithID:<#(NSString * _Nonnull)#> withTitle:<#(NSString * _Nullable)#>];
Chat Kit
Chat Kit SDK has three chat modules: Guided Conversations, Answer Bot and Business Messaging.
The chat components will be displayed below once you enable the Guided Conversation, Answer Bot, and Business Messaging.
(i) Include the following import statement for all method calls related to the Chat kit
Swift
import ZohoDeskPortalChatKit
Objective-C
- @import ZohoDeskPortalChatKit;
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.
(ii) The following methods display the Guided Conversations
Swift
ZDPortalChatKit.showGC()
Objective-C
- [ZDPortalChatKit showGC];
Answer Bot Module
Answer Bot helps end-users find answers from a bot trained on the articles available in the portal's KB module.
(i) The following methods display the Answer Bot
Swift
- ZDPortalChatKit.showAnswerBot()
Objective-C
- [ZDPortalChatKit showAnswerBot];
Business Messaging Module
Business Messaging helps end-users chat with agents directly or with a guided conversation flow.
(i) The following methods display the Business Messaging
Swift
- ZDPortalChatKit.showBM()
Objective-C
- [ZDPortalChatKit showBM];
SalesIQ Module
Chat provides a real-time communication channel for end-users to interact with customer support agents.
(i) The following method displays the Chat module:
Swift
import ZohoDeskPortalSalesIQ
...
ZDPortalSalesIQ.show()
Objective-C
@import ZohoDeskPortalSalesIQ;
...
[ZDPortalSalesIQ show];
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
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 ...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 ...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 ...FAQs: Help Center
What is help center in Desk? Help Center is a customer portal that allows users to learn about the product and understand its processes by accessing knowledge base articles. It provides a platform for self-help and learning, where users can find ...Customizing Help Center Home Page
Customize the way your Help Center content is organized using the simple drag-drop method in Zoho Desk. You can add custom widgets, show or hide tabs and customize their appearance to keep your customers engaged with the right content at the right ...
New to Zoho LandingPage?
Zoho LandingPage Resources