Implementar Flutter SDK en tu proyecto

Después de configurar el entorno de trabajo para desarrollar la aplicación Flutter principalmente en Android o iOS y crear el proyecto Flutter en el IDE, ahora puedes proceder a implementar el Catalyst Flutter SDK en tu proyecto Flutter. Cuando creas un proyecto Flutter, un archivo básico pubspec.yaml se genera y se ubica en la parte superior del árbol del proyecto. Este archivo contiene los metadatos sobre el proyecto y especifica las dependencias que requiere el proyecto.

Instalar el SDK

Necesitarás agregar las siguientes configuraciones para implementar el Catalyst Flutter SDK en el pubspec.yaml de tu proyecto Flutter:

dependencies:
  zcatalyst_sdk:  ^2.2.1

Para instalar el Flutter SDK en tu proyecto, necesitarás ejecutar el siguiente comando desde la terminal de tu IDE:

flutter pub get

Método alternativo para instalar el SDK:

Puedes ejecutar el siguiente comando directamente desde la terminal de tu IDE en el directorio de tu proyecto Flutter para instalar el Flutter SDK, en lugar de agregar las configuraciones en el archivo pubspec.yaml como se mencionó anteriormente:

flutter pub add zcatalyst_sdk

Importar el SDK

Para importar el SDK en el código Dart, necesitarás agregar la siguiente línea de código en el archivo lib/main.dart en el directorio de tu proyecto Flutter:

import 'package:zcatalyst_sdk/zcatalyst_sdk.dart'; 

Inicializar el SDK

Debes inicializar el SDK de Catalyst para habilitar el funcionamiento de los métodos y funcionalidades definidos en el paquete del SDK.

Por lo tanto, antes de configurar tu aplicación para consumir los métodos del SDK, debes inicializar el SDK en tu función main() usando el método ZCatalystApp.init() de cualquiera de las siguientes maneras:

1. Usando el archivo de configuración de Catalyst:

La función de configuración que descargaste anteriormente para Android o iOS indicará el entorno de la aplicación. De manera similar a incluir el archivo de configuración apropiado (app_configuration_development.properties / app_configuration_production.properties para Android y AppConfigurationDevelopment.plist / AppConfigurationProduction.plist para iOS) según el entorno en el proyecto de tu aplicación, debes inicializar el SDK para el entorno apropiado.

Especificando el entorno:

En este método, debes establecer la configuración requerida y especificar el environment de tu aplicación como DEVELOPMENT o PRODUCTION, y pasarlo al método init() a través de la clase ZCatalystApp como se muestra a continuación:

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

A continuación se muestra un fragmento de código de ejemplo:

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

Sin especificar el entorno:

Si el environment no se especifica en la inicialización del SDK, se considerará como PRODUCTION por defecto. Por lo tanto, si tu aplicación está operando en el entorno de Production, puedes inicializar el SDK directamente de la siguiente manera:

await ZCatalystApp.init();

A continuación se muestra un fragmento de código de ejemplo:

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

2. Pasando el objeto de configuración SDK personalizado:

Alternativamente, puedes inicializar el Flutter SDK construyendo un objeto ZCatalystSDKConfigs personalizado que puedes pasar usando la clase ZCatalystSDKConfigsBuilder.

Objeto ZCatalystSDKConfigs

La clase ZCatalystSDKConfigsBuilder tiene las siguientes propiedades de configuración:

Este objeto ZCatalystSDKConfigs ahora se puede pasar usando la clase ZCatalystSDKConfigsBuilder como se muestra a continuación:

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()}');
  }