Install the iOS UI Framework for the User App | Zoho Creator Help

iOS UI framework

This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version.
The UI framework offers predefined view controllers for the components in your Creator application in addition to the capabilities of the core framework. This allows you to include  forms reports , and  pages , directly from your Creator app into your iOS app, and build a custom UI that can interface with the data in your Creator app.

Prerequisites

Note: If your Mac is powered by Apple Silicon (M1, M2, etc.), it's recommended to run Xcode with Rosetta enabled. 

When using Xcode 15 on Apple Silicon Macs (i.e., M1, M2 chips) instead of Intel Macs, we currently only support running in the Simulator under Rosetta destinations.

Register your iOS app with Zoho

Registering your iOS app with Zoho generates a Client ID  and Client Secret combination. These are required to allow your iOS app to integrate with your Creator application. To register your iOS app with Zoho:

  1. Click Mobile from the left pane.
  2. Click on the required row of the iOS app for which you want to configure the UI framework. The For User - SDK  pane will open on the right. 

  3. Click Generate Client.

  4. This will generate the  Client ID, Client secret, and RedirectURI for the iOS app that you want to integrate with your Creator application.

  5. Downloaded the ZCAppInfo.plist file and add it to your project.

Install the iOS UI framework for the user app

  1. Install the Zoho Creator SDK using  Pod :
    1. Add the pod specs to podfile:
      target 'Demo' do
      use_frameworks!
      pod 'ZohoAuth'
      pod 'ZCUIFramework'
      end
      project.targets.each do |target|
      target.build_configurations.each do |config|
      config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.0'
      end
      end
      end
      end
    2. Open the folder containing podfile in terminal, then run:
      $ pod install
  2. Add the following to your Objective-C bridging header:
    #import <ZohoAuthKit/ZohoAuth.h> 
  3. Import ZCUIFramework to use Zoho Creator's iOS UI framework:
    import ZCUIFramework
  4. Configure your project with the following code, for example in the SceneDelegate file:
    class SceneDelegate: UIResponder, UIWindowSceneDelegate {
     var window: UIWindow?
    
      func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
       if let windowScene = scene as? UIWindowScene {
        let window = UIWindow(windowScene: windowScene)
       }
    
       // ZohoAuth Configuration
    
       let scope = ["aaaserver.profile.READ","zohocontacts.userphoto.READ","ZohoContacts.contactapi.READ","ZohoCreator.meta.CREATE","ZohoCreator.meta.READ","ZohoCreator.meta.UPDATE","ZohoCreator.meta.DELETE","ZohoCreator.data.CREATE","ZohoCreator.data.READ","ZohoCreator.data.UPDATE","ZohoCreator.data.DELETE","Stratus.stratusop.READ","ZohoCRM.modules.READ","ZohoCRM.users.READ"]
    let clientID = "<Your Client ID>" let clientSecret = "<Your Client Secret>" let urlScheme = "<Your Url Scheme>" let accountsUrl = "https://accounts.zoho.com" // enter the accounts URL of your respective DC. For eg: EU users use 'https://accounts.zoho.eu'. ZohoAuth.initWithClientID(clientID, clientSecret: clientSecret, scope: scope, urlScheme: urlScheme, mainWindow: window, accountsURL: accountsUrl) // To verify if the app is already logged in ZohoAuth.getOauth2Token { (token, error) in if token == nil { // Not logged in self.showLoginScreen() } else { // App logged-in already. // Ensure to use the following line of code in your iOS app before you utilize any of Creator SDK’s methods Creator.configure(uiDelegate: self) } } } func scene(_ scene: UIScene, openURLContexts URLContexts: Set <UIOpenURLContext> ) { if let context = URLContexts.first { let _ = ZohoAuth.handleURL(context.url, sourceApplication: context.options.sourceApplication, annotation: context.options.annotation) } } } extension SceneDelegate: ZCUIServiceDelegate { func oAuthToken(with completion: @escaping AccessTokenCompletion) { ZohoAuth.getOauth2Token { (token, error) in completion(token, error) } } func configuration() -> CreatorConfiguration { return CreatorConfiguration(creatorURL: "https://creator.zoho.com") // enter the creator URL of your respective data center (DC). For eg: EU users must use 'https://creator.zoho.eu' } func handleBrowserURL(url: URL) { // Get call back here whenever an openURL cannot be opened inside the application by the UI SDK } func openURL(for openURLTasks: [OpenUrlTask]) { // Get Call back here when openurl have query string "zc_MobileSDK_HandleOpenURL=true". // eg, https://app.zohocreator.com/appOwner/app-name/#Form:Test_Form?zc_MobileSDK_HandleOpenURL=true } }

    Code to add Zoho login to your iOS app:
    func showLoginScreen() {
     ZohoAuth.presentZohoSign( in: {
      (token, error) in
      if token != nil {
       // success login
       // Ensure to use the following line of code in your iOS app before you utilize any of Creator SDK’s methods
       Creator.configure(delegate: self)
      }
     })
    }

    Code to provision logout from Zoho:
    func logout() {
     ZohoAuth.revokeAccessToken {
      (error) in
      if error == nil {
       //Logout Successfully
      }
      else {
       //Error Occurred
      }
     }
    }
  5. Add values for the following keys in  ZCAppInfo.plist . These are mandatory parameters for Apple's privacy compliance because their respective services are used in the UI framework.
    'NSCameraUsageDescription', 'NSContactsUsageDescription', 'NSLocationWhenInUseUsageDescription', 'NSMicrophoneUsageDescription', 'NSPhotoLibraryUsageDescription' and 'NSPhotoLibraryAddUsageDescription'

FAQ

  1. I'm a M1 Mac user and I'm facing issues while adding dependencies. What should I do?
    To proceed further, please use the arch=x86_64 pod install command.

References

  1. Refer to the examples page for sample code snippets.
  2. Familiarize yourself with Mobile SDK for iOS by trying out our sample application here.
  3. Please refer to our iOS SDK documentation for detailed information about the various SDK methods.
  4. To configure push notifications for iOS, refer here.

Users

Customers


    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










                                    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

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              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 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

                                                                                                      • iOS UI framework

                                                                                                        This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. In addition to the capabilities of the core framework, the UI framework offers predefined view controllers for the ...
                                                                                                      • iOS core framework

                                                                                                        This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. The core framework of Creator's iOS SDK allows you to create a custom UI and build an iOS app using the data present in your ...
                                                                                                      • iOS core framework

                                                                                                        This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. The core framework of Creator's iOS SDK allows you to create a custom UI and build an iOS app using the data present in your ...
                                                                                                      • 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 ...
                                                                                                      • Android UI library

                                                                                                        This help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version. The Android UI library helps you use the UI components of the modules and also to design your own custom UIs. Prerequisites ...
                                                                                                        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