Page Related Methods - ZCUISDKUtil | Zoho Creator Help

Page related methods

The ZCUISDKUtil of Zoho Creator's Android SDK lets you manage the interface of the components of your Zoho Creator applications.
Note: Zoho Creator's Mobile SDK is currently a Beta feature. We do not recommend using it for apps in the production stage.

Methods related to the pages in your Creator applications

Java

  1. static void startHtmlPageActivity(Activity callingActivity, String appOwnerName, String appLinkName, String htmlPageLinkName, String htmlPageDisplayName, String queryString)
This method will launch the activity with the specified html page loaded in it.

Parameters:

callingActivityCurrent activity instance to launch the next activity.
appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
htmlPageLinkNameThe link name of the html page.
htmlPageDisplayNameThe display name of the html page.
queryString
The query params to be used in page to perform specific actions in html page. Format:
param1=value1&param2=value2

  1.  static Fragment getFragmentForHtmlPage(String appOwnerName, String appLinkName, String htmlPageLinkName, String queryString)

This will return the UI component for the html page component to be embedded it in your custom screen.

Parameters:

appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
htmlPageLinkNameThe link name of the html page
queryString
The query params to be used in page to perform specific actions in html page Format:
param1=value1&param2=value2

Returns:

FragmentHtml page's fragment instance which can be embedded in a activity.
  1. static void startZMLPageActivity(Activity callingActivity, String appOwnerName, String appLinkName, String pageLinkName, String pageDisplayName, String queryString, PageUIBuilder pageUIBuilder)
This method will launch the activity with the specified zml page loaded in it.

Parameters:

callingActivityCurrent activity instance to launch the next activity.
appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
PageLinkNameThe link name of the zml page.
PageDisplayNameThe display name of the zml page.
queryString
The query params to be used in page to perform specific actions in zml page. Format:
param1=value1&param2=value2
pageUIBuilderInstance of PageUIBuilder to customize page's user interface like adding floating menu to page.
  1. static Fragment getFragmentForZMLPage(String appOwnerName, String appLinkName, String pageLinkName, String queryString, PageUIBuilder pageUIBuilder)
This will return the UI component for the zml page component to be embedded it in your custom screen.

Parameters:

appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
PageLinkNameThe link name of the zml page.
queryStringThe query params to be used in page to perform specific actions in zml page. Format:
param1=value1&param2=value2
pageUIBuilderInstance of PageUIBuilder to customize page's user interface like adding floating menu to page.

Returns:

FragmentZml page's fragment instance which can be embedded in a activity.

Kotlin

callingActivityCurrent activity instance to launch the next activity.
appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
htmlPageLinkNameThe link name of the html page.
htmlPageDisplayNameThe display name of the html page.
queryStringThe query params to be used in page to perform specific actions in html page. Format:
param1=value1&param2=value2
  1. static Fragment getFragmentForHtmlPage(String appOwnerName, String appLinkName, String htmlPageLinkName, String queryString)
This will return the UI component for the html page component to be embedded it in your custom screen.

Parameters:

appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
htmlPageLinkNameThe link name of the html page
queryStringThe query params to be used in page to perform specific actions in html page Format:
param1=value1&param2=value2

Returns:

FragmentHtml page's fragment instance which can be embedded in a activity.
  1. static void startZMLPageActivity(Activity callingActivity, String appOwnerName, String appLinkName, String pageLinkName, String pageDisplayName, String queryString, PageUIBuilder pageUIBuilder)
This method will launch the activity with the specified zml page loaded in it.

Parameters:

callingActivityCurrent activity instance to launch the next activity.
appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
PageLinkNameThe link name of the zml page.
PageDisplayNameThe display name of the zml page.
queryStringThe query params to be used in page to perform specific actions in zml page. Format:
param1=value1&param2=value2
pageUIBuilderInstance of PageUIBuilder to customize page's user interface like adding floating menu to page.
  1. static Fragment getFragmentForZMLPage(String appOwnerName, String appLinkName, String pageLinkName, String queryString, PageUIBuilder pageUIBuilder)
This will return the UI component for the zml page component to be embedded it in your custom screen.

Parameters: 

appOwnerNameThe owner name of the application.
appLinkNameThe link name of the application.
PageLinkNameThe link name of the zml page.
queryStringThe query params to be used in page to perform specific actions in zml page. Format:
param1=value1&param2=value2
pageUIBuilderInstance of PageUIBuilder to customize page's user interface like adding floating menu to page.

Returns:

FragmentZml page's fragment instance which can be embedded in a activity.
  1. fun startHtmlPageActivity( callingActivity: Activity, appOwnerName: String, appLinkName: String, htmlPageLinkName: String, htmlPageDisplayName: String, queryString: String)
Launches the activity with the specific HTML page loaded in it.

Parameters:

callingActivityThe activity instance that has to be used to invoke the next activity.
appOwnerNameThe Zoho username of the specified Creator application’s owner.
appLinkNameThe link name of the specified Creator application.
htmlPageLinkNameThe link name of the specified HTML page.
htmlPageDisplayNameThe display name of the specified HTML page.
queryStringThe parameters that are to be passed to the page to make it perform the required actions. Format:
param1=value1&param2=value2
  1. fun getFragmentForHtmlPage( appOwnerName: String, appLinkName: String, htmlPageLinkName: String, queryString: String ): Fragment?
Returns the UI component for the specified page, which you want to embed in the custom screen of your Android app.

Parameters:

appOwnerNameThe Zoho username of the specified Creator application’s owner.
appLinkNameThe link name of the specified Creator application.
htmlPageLinkNameThe link name of the specified HTML page.
queryStringThe parameters that are to be passed to the page to make it perform the required actions. Format:
param1=value1&param2=value2

Returns:

FragmentThe specified HTML page's fragment instance that you can embed in an activity.
  1. fun startZMLPageActivity( callingActivity: Activity, appOwnerName: String, appLinkName: String, pageLinkName: String, pageDisplayName: String, queryString: String, pageUIBuilder: PageUIBuilder?)
Launches the activity with the specified ZML page loaded in it.

Parameters:

appOwnerNameThe Zoho username of the specified Creator application’s owner.
appLinkNameThe link name of the specified Creator application.
pageLinkNameThe link name of the specified ZML page.
pageDisplayNameThe display name of the specified ZML page.
queryStringThe parameters that are to be passed to the specified page to make it perform the required actions. Format:
param1=value1&param2=value2
pageUIBuilderThe instance of PageUIBuilder to customize the specified page's UI, like adding a floating menu to it.
  1. fun getFragmentForZMLPage( appOwnerName: String, appLinkName: String, pageLinkName: String, queryString: String, pageUIBuilder: PageUIBuilder?): Fragment?

Returns the UI component for the specified ZML page that you want to embed in a custom screen of your Android app.

Parameters:

appOwnerNameThe Zoho username of the specified Creator application’s owner.
appLinkNameThe link name of the specified Creator application.
pageLinkNameThe link name of the specified ZML page.
queryStringThe parameters that are to be passed to the specified page to make it perform the required actions. Format:
param1=value1&param2=value2
pageUIBuilderThe instance of PageUIBuilder to customize the specified page's UI, like adding a floating menu to it.

Returns:

FragmentThe specified ZML page's fragment instance that you can embed in your activity.