ZDPortalLiveChat.getChatFragment()

ZDPortalConfiguration.setThemeType(ZDPThemeType.SYSTEM);

MyApplication.deskInstance.enablePush("fcmId");

MyApplication.deskInstance.disablePush("fcmId");

ZDPortalConfiguration.handleNotification(Context context, Map data, int icon);

ZDPortalTicketsAPI.createTicket(new CreateTicketCallback() {
   @Override
   public void onTicketCreated(Ticket ticket) {
   }
   @Override
   public void onException(ZDPortalException exception) {
   }
}, ticketData, params);

ZDPortalAPI.getDepartments(new ZDPortalCallback.DepartmensCallback() { 
   @Override 
   public void onDepartmentsDownloaded(DepartmentsList response) { 
   } 
   @Override 
   public void onException(ZDPortalException exception) { 
   } 
});

To fetch the IDs of the layout in your help desk portal, use the following method.

HashMap<String, String> params = new HashMap<>();
params.put("departmentId", departmentId);
ZDPortalAPI.getLayouts(new ZDPortalCallback.LayoutsCallback() {
    @Override
    public void onLayoutsDownloaded(Layouts layouts) {
	//layout fetch succeed
    }

    @Override
    public void onException(ZDPortalException e) {
	//layout fetch failed
    }
}, params);

HashMap<String, String> options = new HashMap<>(); 
options.put("from", String.valueOf(1)); 
options.put("limit", String.valueOf(100)); 
options.put("departmentId", departmentId); 
ZDPortalAPI.getProductsList(new ZDPortalCallback.ProductsCallback() { 
   @Override 
   public void onProductsDownloaded(ProductsList productsList) { 
      productsMap.put(departmentId, productsList.getData()); 
      responseLiveData.setValue(productsList.getData()); 
   } 
   @Override 
   public void onException(ZDPortalException exception) { 
   } 
}, options);

ZDPortalTicketsAPI.getTicketFields(new TicketFieldsCallback() {
   @Override
   public void onTicketFieldsDownloaded(TicketFieldsList ticketFieldsList) {
   }
   @Override
   public void onException(ZDPortalException exception) {
   }
}, fieldsParams, "apiName");

ZDPortalTicketsAPI.uploadAttachment(new UploadAttachmentCallback() {
   @Override
   public void onAttachmentUploaded(ASAPAttachmentUploadResponse response) {
   }
   @Override
   public void onException(ZDPortalException exception) {
   }
}, fileTobeUploaded, null);

ZDPortalKB.showCategoryWithPermalink(activity, permaLink);

ZDPortalKB.showArticleWithPermalink(activity, permaLink);

ZDPCommunityConfiguration configuration = new ZDPCommunityConfiguration.Builder()
                .isReplyAllowed(true)
                .isReplyEditAllowed(true)
                .isReplyDeleteAllowed(true)
                .isTopicEditAllowed(true)
                .isTopicDeleteAllowed(true).build();
ZDPortalCommunity.setConfiguration(configuration);

HashMap<String, String> params = new HashMap<>();
params.put("from", "1");
params.put("limit", "5");
ZDPortalCommunityAPI.getMostPopularTopics
(new ZDPortalCallback.CommunityTopicsCallback() {
      @Override
      public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) {
      }
      @Override
      public void onException(ZDPortalException e) {
      }
}, params);

HashMap<String, String> params = new HashMap<>();
params.put("from", "1");
params.put("limit", "5");
ZDPortalCommunityAPI.getMostDiscussedTopics(new 
ZDPortalCallback.CommunityTopicsCallback() 
{
   @Override
   public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) 
   {
   }
   @Override
   public void onException(ZDPortalException e) 
   {
   }
}, params);

ZDPortalSubmitTicket.setTicketsFieldsListTobeShown(ticketListTobeShown, deptId, 
layoutId);

ZDPortalSubmitTicket.preFillTicketFields(preFillTicketFields, deptId, layoutId);

ZDPTicketConfiguration configuration = new ZDPTicketConfiguration.Builder()
        .isReplyAllowed(true)
        .isCommentAllowed(true)
        .isCommentEditAllowed(true)
        .isTicketUpdateAllowed(true)
        .build();

ZDPortalTickets.setConfiguration(configuration);

HashMap<String, String> params = new HashMap<>();
params.put("timeZone", "asia/kolkatta");
ZDPortalAPI.updateProfileDetails(new ZDPortalCallback.UserDetailsCallback() {
   @Override
   public void onUserDetailsSuccess(DeskUserProfile userProfile) {
   }
   @Override
   public void onException(ZDPortalException exception) {
   }
}, params);

Params

ASAP configuration changes

ZDPortalConfiguration.setConfiguration(new ZDPConfiguration.Builder().isKBEnabled(false).build())

isKBEnabled(true): displays the KB

isKBEnabled(false): hides the KB

The status of the modules can be changed to either enabled or disabled. However this action can only be performed if the modules are enabled in the ASAP configuration settings.

To display/hide the specific modules/options/buttons, refer to the respective methods mentioned below:

ZohoDeskPortalSDK.Logger.enableLogs();

3.0_BETA-16

1. We implemented the Text-To-Speech and In-Article Search features for the KB Articles.
   

3.0_BETA-15

1. Fixed the App Logo (Launcher Icon) overriding issue.
   

3.0_BETA-14

1. Handled translation for the names of system fields in the Add Ticket Form and Ticket Properties.

3.0_BETA-11

1. Enhanced the dark theme user interface of the rich text across the entire SDK, especially in Article and Topic content. 
   
2. Integrated the latest version of the Guided Conversation SDK into ASAP. Read more Guided Conversation SDK for Android.
3. Extended the options to disable the help center modules. Read more ASAP configuration changes.

1. The option to set the callback for Submit Ticket has been provided as an independent feature. Previously, it was supported only with ZDPortalSubmitTicket.show().
   

          In this version, the ZDPortalSubmitTicket.show(activity, callback) method has been removed. Please use the    

1. Provided an option to disable the Side Menu. See More
   
2. Provided an option to hide the "powered by ASAP label" that is displayed at the bottom of each screen of the ASAP SDK. See More
   

3.0_BETA-0_4

1. Provided an option to customize the fonts in Zoho Desk ASAP SDK. For more information, refer "Customize font typefaces" under Customizing the Add-On UI.
   

3.0_BETA-0_3

The following enhancements were made to the UI:

• Included a header in the Side Menu.
  

• Changed the color of the Default Light and Dark Theme.

ZDPortalLiveChat.getChatFragment()

if(!MyApplication.deskInstance.isUserSignedIn()) { MyApplication.deskInstance.setUserToken(userToken, new ZDPortalCallback.SetUserCallback() { @Override public voidonUserSetSuccess() { //User set success } @Override public voidonException(ZDPortalException e) { //Exception } }); }

boolean isUserLoggedIn = MyApplication.deskInstance.isUserSignedIn();

MyApplication.deskPortalSDK.logout(new ZDPortalCallback.LogoutCallback() { @Override public void onLogoutSuccess() { //User logged out } @Override public void onException(ZDPortalException e) { } });

MyApplication.deskInstance.clearDeskPortalData();

ZDPortalConfiguration.setThemeResource(R.style.deskTheme_Light);

ZDPortalConfiguration.setThemeResource(R.style.deskTheme_Dark);

ZDPortalConfiguration.setThemeResource(R.style.deskTheme);

<style name="deskTheme" parent="deskTheme_Light"> <!-- Customize your theme here. --> <item name="colorPrimary">@color/colorPrimary </item> <item name="colorPrimaryDark">@color/colorPrimaryDark </item> <item name="colorAccent">@color/colorAccent </item> <item name="android:fontFamily">@font/dosis_regular </item> </style>

ZDPortalConfiguration.setLanguage("en");

android { defaultConfig { ... resConfigs "en", "ta", "fi" } }

MyApplication.deskInstance.enablePush("fcmId");

MyApplication.deskInstance.disablePush("fcmId");

ZDPortalConfiguration.handleNotification(Context context, Map data, int icon);

ZDPortalTicketsAPI.createTicket(new CreateTicketCallback() { @Override public void onTicketCreated(Ticket ticket) { } @Override public void onException(ZDPortalException exception) { } }, ticketData, params);

ZDPortalAPI.getDepartments(new ZDPortalCallback.DepartmensCallback() { @Override public void onDepartmentsDownloaded(DepartmentsList response) { } @Override public void onException(ZDPortalException exception) { } });

HashMap<String, String> options = new HashMap<>(); options.put("from", String.valueOf(1)); options.put("limit", String.valueOf(100)); options.put("departmentId", departmentId); ZDPortalAPI.getProductsList(new ZDPortalCallback.ProductsCallback() { @Override public void onProductsDownloaded(ProductsList productsList) { productsMap.put(departmentId, productsList.getData()); responseLiveData.setValue(productsList.getData()); } @Override public void onException(ZDPortalException exception) { } }, options);

ZDPortalTicketsAPI.getTicketFields(new TicketFieldsCallback() { @Override public void onTicketFieldsDownloaded(TicketFieldsList ticketFieldsList) { } @Override public void onException(ZDPortalException exception) { } }, fieldsParams, "apiName");

ZDPortalTicketsAPI.uploadAttachment(new UploadAttachmentCallback() { @Override public void onAttachmentUploaded(ASAPAttachmentUploadResponse response) { } @Override public void onException(ZDPortalException exception) { } }, fileTobeUploaded, null);

ZDPortalKB.showCategoryWithPermalink(activity, permaLink);

ZDPortalKB.showArticleWithPermalink(activity, permaLink);

ZDPCommunityConfiguration communityConfiguration = new ZDPCommunityConfiguration(); communityConfiguration.setTopicEditAllowed(false); communityConfiguration.setTopicDeleteAllowed(false); communityConfiguration.setReplyAllowed(true); communityConfiguration.setReplyEditAllowed(true); communityConfiguration.setReplyDeleteAllowed(false); ZDPortalCommunity.setConfiguration(communityConfiguration);

HashMap<String, String> params = new HashMap<>(); params.put("from", "1"); params.put("limit", "5"); ZDPortalCommunityAPI.getMostPopularTopics(new ZDPortalCallback.CommunityTopicsCallback() { @Override public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) { } @Override public void onException(ZDPortalException e) { } }, params);

HashMap<String, String> params = new HashMap<>(); params.put("from", "1"); params.put("limit", "5"); ZDPortalCommunityAPI.getMostDiscussedTopics(new ZDPortalCallback.CommunityTopicsCallback() { @Override public void onCommunityTopicsDownloaded(DeskTopicsList deskTopicsList) { } @Override public void onException(ZDPortalException e) { } }, params);

Tickets

Hiding Fields in the Submit Ticket Form

ZDPortalSubmitTicket.setTicketsFieldsListTobeShown(ticketListTobeShown, deptId);

1. ticketListTobeShown - List of strings (apiName of the Ticket Fields)
   
2. deptId - ID of the department for which you want to configure the Ticket Fields list.
   

Hiding Mandatory Fields in the Submit Ticket Form

ZDPortalSubmitTicket.preFillTicketFields(preFillTicketFields, deptId);

1. preFillTicketFields - List of PreFillTicketField objects
   
2. deptId - ID of the department for which you want to configure the Ticket Fields list.
   

1. fieldApiName - string - apiName of the ticket field. You can retrieve the apiName of each field using the getTicketFields() method.
   
2. fieldValue - object
   
   1. For multiselect fields, pass the values allowed, as a list of strings.
      
   2. For pick list fields, pass one of the values allowed, as a string.
      
   3. For date fields, pass the value as a string in the dd-MM-yyyy format.
      
   4. For dateTime fields, pass the value as a string in the dd-MM-yyyy HH:mm a format.
      
   5. For Boolean fields, pass a Boolean value.
      
   6. For all other field types, pass the values as string objects.
      
   7. Make sure that the values you pass adhere to the maxlength and decimal restrictions defined for the field.
      
3. isEditable - Boolean - Key that defines if the value in the field is editable or not
   

Note: For more clarity, refer to the sample code here .

Custom-Configuring Ticket Actions

ZDPTicketConfiguration ticketConfiguration = new ZDPTicketConfiguration(); ticketConfiguration.setReplyAllowed(false); ticketConfiguration.setCommentAllowed(true); ticketConfiguration.setTicketUpdateAllowed(true); ticketConfiguration.setCommentEditAllowed(false); ticketConfiguration.setCommentDeleteAllowed(false); ZDPortalTickets.setConfiguration(ticketConfiguration);

Others

HashMap<String, String> params = new HashMap<>(); params.put("timeZone", "asia/kolkatta"); ZDPortalAPI.updateProfileDetails(new ZDPortalCallback.UserDetailsCallback() { @Override public void onUserDetailsSuccess(DeskUserProfile userProfile) { } @Override public void onException(ZDPortalException exception) { } }, params);

SDK Logging

ZohoDeskPortalSDK.Logger.enableLogs();

Note: Some debug information related to the SDK is stored in logcat. Therefore, make sure that enableLogs() does not exist in the release build.