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


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Intake FormsLegalMobile App
                              Form DesignerHRMobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsEncrypted Forms

                              Secure Forms

                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now






                                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

                                                                                                                        • ZCNotificationService

                                                                                                                          This service lets you manage the mobile push notifications with regards to the Zoho Creator SDK. Note: Zoho Creator's Mobile SDK is currently a Beta feature. We do not recommend using it for apps in the production stage Methods ...
                                                                                                                        • iOS SDK

                                                                                                                          This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. Mobile Software Development Kits (mobile SDK) provide a set of software development tools that allow for a wide range of ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources