ASAP for Mobile Platforms

Displaying Help Components

Given below are the methods for displaying individual help components on the SDK UI. These methods display the components according to their default configuration and the settings configured in your Zoho Desk portal. The components in the default configuration vary according to the Zoho Desk edition in use. 

SDK Dashboard

The SDK dashboard is the screen through which end-users access your help center. This dashboard displays icons/buttons that provide access to your knowledge base, user community, customer support team (through the ticket submission form), tickets list (list of tickets submitted by users who are logged in), and live chat (to interact with a customer support agent in real time).

Note: Live chat is not enabled by default in the SDK UI. You must first enable live chat in your Zoho Desk portal.

The following methods display the SDK dashboard.

Swift

ZohoDeskPortalSDK.showHomePage(controller: self)

Objective-C

[ZohoDeskPortalSDK showHomePageWithController:self];

self is the UIViewController instance that triggers the SDK dashboard.

You also have the option to not display the SDK dashboard on your app and still provide access to individual help components. The following methods help you display the individual components with their default configuration. 

Live Chat

Live chat is the component through which end-users can interact with a customer support agent in real time.

The following methods display the live chat component.

Swift

ZohoDeskPortalSDK.showLiveChat(controller: self)

Objective-C

[ZohoDeskPortalSDK showLiveChatWithController:self];

self is the UIViewController instance that triggers live chat.

Help Center (Knowledge Base)

Help center is the component through which end-users can access help articles in your knowledge base.

The following methods display the help center (knowledge base).

Swift

ZohoDeskPortalSDK.showHelpCenter(controller: self)

Objective-C

[ZohoDeskPortalSDK showHelpCenterWithController:self];

self is the UIViewController instance that triggers the knowledge base.

Submit Ticket

Submit Ticket is the screen through which end-users can submit their questions/requests as support tickets.

The following methods display the Submit Ticket Screen.

Swift

ZohoDeskPortalSDK.addTicket(controller: self)

Objective-C

 [ZohoDeskPortalSDK addTicketWithController:self];

self is the UIViewController instance that triggers the Submit Ticket screen.

If you want your app to subscribe to the submit ticket event, use the following method, which includes an event callback.

Swift

ZohoDeskPortalSDK.addTicket(controller: self, onCompletion: { (ticketDetail) in
  // The ticketDetail parameter contains the details of the ticket created.
  // Your program logic goes here.
}) { (error) in
  // error creating Ticket
}

Objective-C

[ZohoDeskPortalSDK addTicketWithController:self onCompletion:^(TicketDetailJsonObject * ticket) {
  // The ticketDetail parameter contains the details of the ticket created.
  // Your program logic goes here.
} onError:^(NSError * error) {
    // error creating Ticket
}];

self is the UIViewController instance that triggers the Submit Ticket screen.

The callback object that sends ticket information when a ticket is submitted via the Submit Ticket screen.

Note: If an authenticated user submits a ticket, all ticket details are sent to your app. If a guest user submits a ticket, only the ticket number is sent.

My Tickets

My Tickets is the screen through which end-users can access, track, and edit the tickets they submitted.

The following methods display the My Tickets screen.

Swift

ZohoDeskPortalSDK.ticketList(controller: self)

Objective-C

[ZohoDeskPortalSDK ticketListWithController:self];

self is the UIViewController instance that triggers the My Tickets screen.

User Community

User community is the component through which end-users can access discussion forums and interact with other users for sharing knowledge.

The following methods display the user community.

Swift

ZohoDeskPortalSDK.showCommunity(controller: self)

Objective-C

[ZohoDeskPortalSDK showCommunityWithController:self];

self is the UIViewController instance that triggers the user community.