Implement Flutter SDK in your Project

After setting up the working environment for developing the Flutter app primarily in Android or iOS and creating the Flutter project in the IDE, you can now proceed to implement the Catalyst Flutter SDK in your Flutter project. When you create a Flutter project, a basic pubspec.yaml file is generated and located at the top of the project tree. This file contains the metadata about the project and specifies the dependencies that the project requires.

Install the SDK

You will need to add the following configurations to implement the Catalyst Flutter SDK to the pubspec.yaml of your Flutter project:

    

        
copy
        

            

        
    
    

         dependencies:
  zc_flutter_sdk:  ^1.1.0
    

To install the Flutter SDK in your project, you will need to execute the following command from your IDE’s terminal:

    

        
copy
        

            

        
    
    

         flutter pub get
    

Alternate Method to install the SDK:

You can execute the following command directly from your IDE’s terminal in your Flutter project’s directory to install the Flutter SDK, instead of adding the configurations in the pubspec.yaml file as mentioned above:

    

        
copy
        

            

        
    
    

         flutter pub add zcatalyst_sdk
    

Import the SDK

To import the SDK in the Dart code, you will need to add the following line of code in the the lib/main.dart file in your Flutter project directory:

    

        
copy
        

            

        
    
    

         import 'package:zc_flutter_sdk/zc_flutter_sdk.dart'; 
    

Initialize the SDK

You must initialize the Catalyst SDK to enable the functioning of the methods and features defined in the SDK package.

Therefore, before you configure your app to consume the SDK methods, you must initialize the SDK in your main() function using the ZCatalystApp.init() method in any one of the following methods:

1. Using the Catalyst Configuration File:

The configuration function that you downloaded previously for Android or iOS will indicate the environment of the app. Similar to including the appropriate configuration file (app_configuration_development.properties / app_configuration_production.properties for Android and AppConfigurationDevelopment.plist / AppConfigurationProduction.plist for iOS) based on the environment in your app’s project, you must initialize the SDK for the appropriate environment.

By specifying the environment:

In this method, you must set the required configuration and specify the environment of your app as either DEVELOPMENT or PRODUCTION, and pass it to the init() method through the ZCatalystApp class as shown below:

    

        
copy
        

            

        
    
    

         ZCatalystApp.init({
      ZCatalystEnvironment? environment,
    });
    

A sample code snippet is shown below:

    

        
copy
        

            

        
    
    

         void main() async {
  try {
    await ZCatalystApp.init(environment: ZCatalystEnvironment.DEVELOPMENT);
  } on ZCatalystException catch (ex) {
    print('Initialized Failed: ${ex.toString()}');
  }
}
    

Without specifying the environment:

If the environment is not specified in the SDK initialization, it would be considered as PRODUCTION by default. Therefore, if your app is operating in the Production environment, you can initialize the SDK directly in the following way:

    

        
copy
        

            

        
    
    

         await ZCatalystApp.init();
    

A sample code snippet is shown below:

    

        
copy
        

            

        
    
    

         void main() async {
  try {
    await ZCatalystApp.init();
  } on ZCatalystException catch (ex) {
    print('Initialized Failed: ${ex.toString()}');
  }
}
    

2. By passing the custom SDK Configuration Object:

Alternatively, you can initialize the Flutter SDK by building a custom ZCatalystSDKConfigs object that you can pass using the ZCatalystSDKConfigsBuilder class.

ZCatalystSDKConfigs Object

The ZCatalystSDKConfigsBuilder class has the following configuration properties:

This ZCatalystSDKConfigs object can now be passed using the ZCatalystSDKConfigsBuilder class as shown below:

    

        
copy
        

            

        
    
    

         ZCatalystSDKConfigs sdkConfigs = ZCatalystSDKConfigsBuilder(
          apiBaseURL: 'https://api.catalyst.zoho.com',
		accountsPortalBaseURL: 'https://accounts.zoho.com',
          clientID: '100****************************FX',
          clientSecret: '19ed***************************2s',
          environment: ZCatalystEnvironment.DEVELOPMENT,
          oauthScopes: 'ZOHOCATALYST.tables.rows.ALL, ZOHOCATALYST.tables.columns.ALL',
          portalID: '10******79',
          projectID: 28*******90,
          redirectURL: '*****')
     .setUserAgent("ZCatalyst Sample App")
     .build();
  try {
    await ZCatalystApp.init(sdkConfigs: sdkConfigs);
  } on ZCatalystException catch (ex) {
    print('Initialized Failed: ${ex.toString()}');
  }

    

If the SDK is successfully initialized, the app will invoke the component methods and function as intended.