プロジェクトへのFlutter SDKの実装

AndroidまたはiOSでFlutterアプリの開発環境をセットアップし、IDEでFlutterプロジェクトを作成した後、FlutterプロジェクトにCatalyst Flutter SDKを実装できます。 Flutterプロジェクトを作成すると、基本的なpubspec.yamlファイルが生成され、プロジェクトツリーの最上位に配置されます。このファイルには、プロジェクトに関するメタデータとプロジェクトが必要とする依存関係が含まれています。

SDKのインストール

Catalyst Flutter SDKを実装するには、Flutterプロジェクトのpubspec.yamlに以下の設定を追加する必要があります：

dependencies:
  zcatalyst_sdk:  ^2.2.1

プロジェクトにFlutter SDKをインストールするには、IDEのターミナルから以下のコマンドを実行する必要があります：

flutter pub get

SDKをインストールする別の方法：

上記のpubspec.yamlファイルに設定を追加する代わりに、FlutterプロジェクトのディレクトリでIDEのターミナルから以下のコマンドを直接実行して、Flutter SDKをインストールできます：

flutter pub add zcatalyst_sdk

SDKのインポート

DartコードでSDKをインポートするには、Flutterプロジェクトディレクトリのlib/main.dartファイルに以下のコード行を追加する必要があります：

import 'package:zcatalyst_sdk/zcatalyst_sdk.dart'; 

SDKの初期化

SDKパッケージで定義されたメソッドと機能を有効にするために、Catalyst SDKを初期化する必要があります。

そのため、SDKメソッドを使用するようにアプリを設定する前に、以下のいずれかの方法でmain()関数内のZCatalystApp.init()メソッドを使用してSDKを初期化する必要があります：

1. Catalyst Configuration Fileを使用する方法：

以前にAndroidまたはiOS用にダウンロードした設定ファイルは、アプリの環境を示します。アプリのプロジェクトの環境に基づいて適切な設定ファイル（Androidの場合はapp_configuration_development.properties / app_configuration_production.properties、iOSの場合はAppConfigurationDevelopment.plist / AppConfigurationProduction.plist）を含めるのと同様に、適切な環境でSDKを初期化する必要があります。

環境を指定する場合：

この方法では、必要な設定を行い、アプリのenvironmentをDEVELOPMENTまたはPRODUCTIONのいずれかに指定し、以下に示すようにZCatalystAppクラスのinit()メソッドに渡します：

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

サンプルコードスニペットを以下に示します：

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

環境を指定しない場合：

SDKの初期化時にenvironmentが指定されない場合、デフォルトでPRODUCTIONとみなされます。そのため、アプリがProduction環境で動作している場合は、以下の方法で直接SDKを初期化できます：

await ZCatalystApp.init();

サンプルコードスニペットを以下に示します：

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

2. カスタムSDK Configurationオブジェクトを渡す方法：

別の方法として、ZCatalystSDKConfigsBuilderクラスを使用して渡せるカスタムZCatalystSDKConfigsオブジェクトを構築して、Flutter SDKを初期化できます。

ZCatalystSDKConfigsオブジェクト

ZCatalystSDKConfigsBuilderクラスには、以下の設定プロパティがあります：

このZCatalystSDKConfigsオブジェクトは、以下に示すようにZCatalystSDKConfigsBuilderクラスを使用して渡すことができます：

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

SDKが正常に初期化されると、アプリはコンポーネントメソッドを呼び出し、意図した通りに機能します。