ZCPageAPIService | Zoho Creator Help

ZCPageAPIService

This API service lets you manage the different functionalities in a page.
Methods
fetch(for:completionHandler:)This fetches the contents of a page.
 
fetchExternalData(forIds:pageInfo:completionHandler:)This fetches fetches the data for the components in the page.
 
executeFunction(forAction:pageInfo:completionHandler:)This fetches the data for the components in the page.
 
downloadImage(forUrlString:pageInfo:completionHandler:)This fetches the image corresponding to the given URL.
 
downloadImage(forFileName:pageInfo:completionHandler:)This fetches the image corresponding to the given file name.
 
fetchNotificationInfoFetches the meta data of the record (ID, report link name, and application link name) from the notification.
 
fetchNotificationsFetches the last 200 notifications that the end user received
 
 
fetch(for:completionHandler:)

Parameters

pageInfoAn object which holds page Info.
completionHandlerThe Page object will be returned to the completionHandler
 
fetchExternalData(forIds:pageInfo:completionHandler:)

Parameters

IdsThe ID for one or more components for which the data are to be fetched.
pageInfoAn object which holds page Info.
completionHandlerString dictionary of values corresponding to the IDs will be returned to the completionHandler
 
executeFunction(forAction:pageInfo:completionHandler:)

Parameters

pageActionThe action model containing the identifer of the function which has to be executed
pageInfoAn object which holds page Info.
completionHandlerThe ExecuteFunctionResult will be returned to the completionHandler
 
downloadImage(forUrlString:pageInfo:completionHandler:)

Parameters

urlStringURL String of image that is to be downloaded
pageInfoAn object which holds page Info.
completionHandlerThe image data will be returned to the completion handler.
 
downloadImage(forFileName:pageInfo:completionHandler:)

Parameters

fileNameThe file name of the image which is to be downloaded
pageInfoAn object which holds page Info.
completionHandlerThe image data will be returned to the completion handler.
 
fetchNotificationInfo(for notification: ZCNotification, completionHandler: @escaping (Result<NotificationInfo>) -> Void)

Parameters

ZCNotificationContains raw notification information
NotificationInfoContains notification record information
 
fetchNotifications(forZUID zuid: String, completionHandler: @escaping (Result<[ZCNotification]>) -> Void)

Parameters

zuidThe end user's ZUID, which can be fetched using the fetchUserInfo API
ZCNotificationContains the list of notifications

  1. ZCFormAPIService
  2. ZCReportAPIService
  3. ZCApprovalAPIService
  4. ZCNotificationService