Class Definition (Kotlin) - ZCUISDKUtil | Zoho Creator Help

Class Definition (Kotlin)


Note: Zoho Creator's Mobile SDK is currently a Beta feature. We do not recommend using it for apps in the production stage.

The ZCUISDKUtil of Zoho Creator's Android SDK lets you manage the interface of the components of your Zoho Creator applications.

SubmitHandler

This interface is to assign a callback (from the Form) upon successful form submission.

Methods:

fun onSuccess(zcActionResult: ZCActionResult)

Upon successful form submission this method will be triggered with ZCActionResult, which contains the resultant form's success message, status, record ID and so on.

 

Report attributes

When including your Creator application's reports in your Android apps, you can add the following parameters as querystring to customize the report's UI:

MethodsDescription
isTitleEnabled=trueShows the report's title (also known as display name).
isHeaderMenuEnabled=trueShows the menu options in the report's title bar.
isFooterEnabled=trueShows the report's footer bar.
isSearchEnabled=trueShows the search option in the report when its footer bar is enabled (isFooterEnabled=true).
isGroupEnabled=trueShows the group-by option in the report when its footer bar is enabled (isFooterEnabled=true).
isSortEnabled=trueShows the sort option in the report when its footer bar is enabled (isFooterEnabled=true).
isFilterEnabled=trueShows the filter option in the report when its footer bar is enabled (isFooterEnabled=true).
isCustomFilterEnabled=trueShows the report's predefined custom filters when its title bar is enabled (isTitleEnabled=true).
showTotalRecordsCount=trueShows the record count in the report when its footer bar is enabled (isFooterEnabled=true).
isPrintEnabled=trueEnables the print option for the records in the report.
isExportEnabled=trueEnables the export option in the report when its title bar is enabled (isTitleEnabled=true).

 

ZCCallbackHelper

Interface definition for a callback to be invoked when the login session is cleared or invalidated.

Methods:

boolean onInvalidTokenErrorOccurred()

Called when login session is cleared. It can be used to show customized messages to user and proceed with the logout action. If it returns false, the logout action will be executed by default.

 

ZCResultCallback

Interface definition for a callback to be invoked to notify the status of an action.

Methods:

void onSuccess()

Called when the action is successfully executed.

void onError(ZCStatusCode statusCode, Exception e)

Called when the execution of an action fails

  1. Common methods
  2. Form related methods
  3. Report related methods
  4. Page related methods
  5. Class Definition (Java)