To create the add-on, perform the following steps:

1. In Zoho Desk, go to Setup > Channels > ASAP.

2. In the Setup pane on the left, under ASAP, click the + button next to Mobile. The Create Mobile Add-On page appears.

3. Under Add-On Details, configure the following settings:

1. Name: Name for the ASAP add-on. The name is only for reference; it does not appear anywhere on the app UI.
   

2. Available for: Departments for which this ASAP add-on must be enabled.

3. Bundle ID: Enter the bundle ID of your app in the appropriate field for iOS/Android. 
   

Bundle ID is mandatory for enabling Live Chat and Push Notifications.

4. Chat: Toggle switch to enable or disable the Chat feature, offering three options for customization. You can choose to enable or disable Zia, Guided Conversations(GC), and Live Chat.
   

The Live Chat component reflects the settings configured for the chat   channel in your help desk portal. Therefore, any change required must be done via the Setup page in Zoho Desk.

5. Push Notifications: Toggle switch to enable or disable Push Notifications. 

JWT-based user authentication is mandatory for enabling Ticket notifications. Push Notifications related to tickets are not sent to anonymous users.

6. Authentication Method: User authentication setting for the add-on
   

1. Anonymous (guest) users : The end-users who are not authenticated are anonymous users. They can only submit tickets, view posts in the user community, and chat with a customer support agent. They cannot view the tickets they submitted or actively participate in the user community.
   

2. JWT (registered) users : The registered end-users are authenticated users. The JWT authentication method is used to verify the end user's identity. In addition to the activities that guest users can perform, authenticated users can also view and track the status of the tickets they submitted, reply/comment on a ticket, and actively participate in the user community (with rights to perform actions such as following a topic, adding a topic, and adding a comment to existing posts). 

 4. Click Save.

dependencies:
zohodesk_portal_services: version

allprojects
{ 	
	repositories
	{ 	
		maven { url 'https://maven.zohodl.com/'} 
		maven { url 'https://downloads.zohocdn.com/wmslibrary' }
	}
} 

import 'package:zohodesk_portal_kb/zohodesk_portal_kb.dart' show ZohodeskPortalKb;
ZohodeskPortalKb.show();

(iii) Community

import 'package:zohodesk_portal_community/zohodesk_portal_community.dart' show ZohodeskPortalCommunity;
ZohodeskPortalCommunity.show();

ZDPTheme theme = new ZDPTheme.Builder(true)
        .setColorPrimary(Color.parseColor(colorString))
        .setColorAccent(Color.parseColor(colorString))
        .build();
ZDPortalConfiguration.setThemeBuilder(theme);

iOS

ZDPThemeManager.updateLightTheme(theme: <#ZDPThemeProtocol#>)

ZDPThemeManager.updateDarkTheme(theme: <#ZDPThemeProtocol#>)

(i) Authenticating users:

import 'package:zohodesk_portal_apikit/zohodesk_portal_apikit.dart' show ZohodeskPortalApikit;
ZohodeskPortalApikit.login(jwtToken, (isSuccess)
 {
	//Sign in success/failed
    });

1. callback will be called after userFetch is executed.
2. isSuccess will indicate whether the user authentication was successful or not.

(ii) Logging out users:

import 'package:zohodesk_portal_apikit/zohodesk_portal_apikit.dart' show ZohodeskPortalApikit;
ZohodeskPortalApikit.logout((isSuccess)
 {
	//Sign out success/failed
 });

1. callback will be called after userFetch is executed.
2. isSuccess will indicate whether the user's logout attempt was successful or not.
   

Code is common for both iOS and Android platforms.

Push Notifications

Push notifications are sent to the end-users on the following situations:

1. Ticket priority update
2. Ticket status update
3. Agent's reply
4. Agent's public comment
5. Agent's reply to the Live Chat
   

Configuring Push Notifications settings

Ensure that the Push Notifications setting is enabled on the ASAP setup page in Zoho Desk. For more information, refer to 'Push Notifications' section under "Create a mobile add-on in Zoho Desk." 

For iOS, create and upload a valid Apple Push Notification Service (APNs) certificate and its password.

Refer to document to learn about Apple Push Notifications.

Enable Push Notifications

Android

import package:zohodesk_portal_apikit/zohodesk_portal_apikit.dart show ZohodeskPortalApikit;
ZohodeskPortalApikit.enablePush(_fcmToken);

iOS

func application
(_ application: UIApplication,
didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) 
{ 
let token = deviceToken.reduce
("", {$0 + String(format: "%02X", $1)}).uppercased() 
ZohoDeskPortalSDK.enablePushNotification
(deviceToken:token, mode: .production) 
}

To ensure the accuracy of notifications:

1. Test the functionality in development mode.
2. Transition to development mode by replacing ".production" with ".sandbox" in the provided code snippet and Desk Setup.
3. Remember to switch back to production mode before deploying the application for end-customer usage.
   

Disable Push Notifications

To disable Push Notifications, include the following code snippet in the main.dart class file:

import package:zohodesk_portal_apikit/zohodesk_portal_apikit.dart show ZohodeskPortalApikit;
ZohodeskPortalApikit.disablePush(_fcmToken);

_fcmToken is the string that is retrieved using 'FirebaseMessaging.instance.getToken().'

 Learn more on how to retrieve the fcm token. Before enabling or disabling Push Notifications, the token must be passed beforehand.

import 'package:zohodesk_portal_apikit/zohodesk_portal_apikit.dart' show ZohodeskPortalApikit;
ZohodeskPortalApikit.enableLogs();