セットアップ

CatalystプロジェクトとiOSプロジェクトを作成した後、以下の手順に従ってiOS SDKパッケージをアプリにセットアップおよび統合する必要があります。

Step 1: iOSアプリをCatalystに登録する

まず、CatalystでiOSアプリのパッケージを作成して登録し、固有の設定ファイルをダウンロードします。

1. プロジェクトのCatalystコンソールから設定アイコンをクリックします。

2. 設定メニューのProject Settingsの下にあるDeveloper Toolsに移動し、iOSタイルをクリックします。 または、下のAdd Packageボタンをクリックすることもできます。

3. 一意に識別できるパッケージ名を入力します。エンドユーザーがアプリにログインした後にリダイレクトするURLを、Redirect URLとして指定します。 ここで入力した値は、設定ファイルに自動的に入力されます。

OSタイプとしてiOSが選択されていることを確認してください。

4. Createをクリックして、モバイルSDKパッケージを作成します。

5. コンソールに設定ファイルをダウンロードできるウィンドウが表示されます。Downloadをクリックしてファイルをダウンロードします。

必要なすべての設定が含まれたファイルがダウンロードされます。このファイルのプロパティについては、次のステップで説明します。

Step 2: iOSプロジェクトに設定ファイルをインポートする

Catalystは、アプリケーションを開発・構築するために、DevelopmentサンドボックスとライブのProduction環境の2つの作業環境を提供しています。詳細については、環境のヘルプページをご覧ください。

コンソールでパッケージを作成すると、現在作業している環境に関係なく、最初はDevelopment環境の設定ファイルのみがダウンロード可能です。パッケージが作成された後は、いつでもコンソールから任意の環境の設定ファイルをダウンロードできます。

各環境の設定ファイルの名前は以下の通りです。

• Development: AppConfigurationDevelopment.plist
• Production: AppConfigurationProduction.plist

作業している環境に基づいて、適切なファイルをダウンロードし、iOSプロジェクトのTargets -> Runnerに追加する必要があります。Production環境の設定ファイルを取得するには、まずプロジェクトをProductionにデプロイしてから、Developer Tools設定セクションからファイルをダウンロードする必要があります。

設定ファイルは、iOSプロジェクトのTargets -> Runnerに追加する必要があります。

iOSプロジェクト構造の詳細については、公式iOSドキュメントを参照してください。

AppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルのプロパティ

アプリ設定ファイルは、以下の表に記載されたプロパティを定義します。リクエストヘッダーを除くすべての値は、プロジェクトの詳細またはデフォルトの標準に基づいて自動的に入力されます。

Step 3: アプリにCatalyst iOS SDKを追加する

次のステップは、SDKパッケージをアプリに含めることです。CocoaPodsを使用してCatalyst SDKライブラリをインストールできます。

新規または既存のプロジェクトにCatalyst iOS SDKを依存関係として追加するには:

1. プロジェクトのPodfileのアプリのターゲットの下に、以下のコードスニペットを挿入します:

pod 'ZCatalyst', :git =>'https://github.com/zoho/Catalyst-iOS-SDK.git', :tag => '2.2.2'

2. システムのターミナルからpod installコマンドを実行します。

これによりPodがインストールされ、Catalyst iOS SDKがiOSアプリに追加されます。

Step 4: アプリのログインリダイレクトを設定する

ユーザーがアプリに正常にログインすると、アプリのホーム画面にリダイレクトされます。このユーザーログインとリダイレクトはCatalyst SDKによって処理されます。

このリダイレクトが正しく処理されるようにするには、iOSプロジェクトのinfo.plistファイルに、以下のキーを同じ設定で含めてください:

Step 5: SDKを初期化する

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

したがって、SDKメソッドを使用するようにアプリを設定する前に、以下の方法でSDKを初期化する必要があります:

public func initSDK( window : UIWindow, environment : ZCatalystEnvironment, appConfiguration : ZCatalystAppConfiguration ) throws

パラメータ:

• window: ビューにイベントをディスパッチするウィンドウオブジェクト
• environment: アプリの環境。.developmentまたは.productionのいずれかです。
• appConfiguration: SDKの機能に必要なすべての設定詳細を含むオブジェクト

ここでのenvironmentは、アプリがDevelopmentまたはProduction環境で動作しているかを示します。環境に基づいて適切なplist設定ファイルをアプリのプロジェクトに含めるのと同様に、適切な環境でSDKを初期化する必要があります。

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

Step 6: アプリケーション画面へのリダイレクトを設定する

iOSアプリに設定したログインページが別のドメインからのものである場合、アプリケーション画面へのリダイレクトを設定できます。ログインに成功すると、アプリケーションレイヤーにリダイレクトされます。

UIApplicationインスタンスのコードは以下の通りです:

ZCatalystApp.shared.handleLoginRedirection( _ url : URL, sourceApplication : String?, annotation : Any )  AppDelegate.swift

パラメータ:

• url: ログイン成功後に開くURLリソース
• sourceApplication: URLを開くことを要求しているアプリのバンドルID
• annotation: アプリがURLとともに送信する追加データ

UISceneインスタンスのコードは以下の通りです:

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    if let context = URLContexts.first
    {
        ZCatalystApp.shared.handleLoginRedirection(context.url, sourceApplication: context.options.sourceApplication, annotation: context.options.annotation as Any)
    }
}

セットアップは完了です。Catalyst iOS SDKを使用してiOSアプリを構築できます。