環境変数

環境変数とは

注意：この機能を利用する前に、起動時引数を処理するコードの定義を開発者の方に実施していただく必要があります。

環境変数とはiOSでは起動時変数のことを指します。この機能の振る舞いは、アプリ内にあらかじめ定義されたコードによって変化します。コード側を変更後、この機能を用いて特定の値をアプリに渡すことができます。環境変数の利用例としては以下のものがあります。

• サーバのエンドポイントをそれぞれのシナリオごとに変更する
• アプリの状態をシナリオ毎に変更する

アプリ側への変更

この機能を利用するためには、アプリ側で起動時変数を処理できるようになっている必要があります。以下Swiftでのサンプルコードです。サンプルコードの<Key>の値はAutifyで登録するKeyと同じである必要があります。

#if DEBUG 
    if ProcessInfo.processInfo.environment["<Key>"] != nil { 
        // Do something 
    } 
#endif

SwiftのProcessInfoクラスの詳細な情報はAppleの公式ドキュメントを参照してください。

• ProcessInfo | Apple Developer

環境変数の作成

iOS

1. 左サイドバー内の「環境変数」をクリック

2. "iOS" タブをクリック

3. "環境変数作成" をクリックし、必要なデータを指定します
   

それぞれの入力項目の説明は以下の通りです。

• 名称
  • 設定する環境変数を識別するための、ユニークな値
• Key
  • 変数名
• Value
  • 変数値
• 説明（任意）
  • 環境変数の説明

3. "作成" をクリック

Android

1. 左サイドバー内の「環境変数」をクリック

2. “Androidタブ” を押下

3. “スタートアクティビティ作成” を押下
   

4. 必要データを指定します
   ※ 上述しておりますように、Androidで環境変数を利用する場合、"appPackage” と “appActivity” の指定 が必須です。Keyから選択し、それぞれ作成してください。
   

   よく利用するキーと値の説明：

   • appPackage（必須）

     • Package名

     • 値の例：

       com.example.app

   • appActivity（必須）

     • Activity名

     • 値の例：

       .ExampleActivity

   • optionalIntentArguments (任意）

     • インテント引数。このキーを利用する場合にその値は、公式ドキュメント “インテント引数の指定” にあるようにオプションを含めたものを指定してください。
     • 値の例：

     Name	Key	Value
     Example 1	optionalIntentArguments	--es API_URL example.com
     Example 2	optionalIntentArguments	--el USER_ID 127

5. "作成" をクリック

環境変数の編集、削除

環境変数の編集と削除は環境変数一覧よりご利用いただけます。

シナリオで環境変数を利用する

新規および既存のシナリオもしくはステップグループ作成する時に、ビルドファイル選択画面にて環境変数を利用することができます。

1. 対象のビルドファイルを選択
2. 「環境変数を設定する」ボタンを選択
   
3. 使用する環境変数を選択
   
4. 「決定」を選択

その他

• 環境変数の登録上限数はありません。