プロファイルの切り替え

SWITCH_TO_PROFILE

アプリケーションの関連付けを、指定したプロファイルに切り替えるために使用します。指定したプロファイルは、別のアプリケーションに関連付けられていない必要があります。アプリケーションを複数のプロファイルに関連付けることはできません。

注意: GET_IGNORE_DISABLED_PROFILES API が値「true」を返す場合、無効なプロファイルには切り替わりません。

プロファイルの要約

DataWedge は、プロファイルとプラグインに基づいています。プロファイルには、DataWedge が特定のアプリケーションでどのように動作するかに関する情報が含まれます。

プロファイル情報は、以下で構成されています。

関連付けられたアプリケーション
入力プラグインの構成
出力プラグインの構成
処理プラグインの構成

DataWedge には、DataWedge の初回実行時に自動的に作成されるデフォルトプロファイルの Profile0 が含まれています。

プロファイルを使用すると、各アプリケーションに特定の DataWedge 構成を割り当てることができます。たとえば、各ユーザーアプリケーションがフォアグラウンドになっているときに、スキャンしたデータを必要な形式で出力するプロファイルを、そのアプリケーションに割り当てることができます。キャプチャされた同一のデータのセットを、各アプリケーションの要件に基づいて、異なる方法で処理するように、DataWedge を構成することができます。

注意事項

1 つのプロファイルを 1 つ以上のアクティビティまたはアプリに関連付けることができます。ただし、1 つのアクティビティを複数のプロファイルに関連付けることはできません。

使用方法

あるアプリケーションに 2 つのアクティビティがあるとします。ActivityA では、EAN13 バーコードだけをスキャンする必要があります。ActivityB では、MSR カードデータだけを必要とします。ProfileB は、EAN13 バーコードだけをスキャンするように構成されており、関連付けられていません。ProfileM は、MSR 入力だけを受け入れるように構成されており、関連付けられていません。ActivityA が開始されると、ProfileB をアクティブにするために SWITCH_TO_PROFILE が使用されます。同様に、ActivityB が開始されると、ProfileM をアクティブにするために SWITCH_TO_PROFILE が使用されます。

別のアクティビティ/アプリがフォアグラウンドになっている場合は、DataWedge の自動プロファイル切り替えによって、適宜、デフォルトプロファイルまたは関連付けられたプロファイルのいずれかに DataWedge プロファイルが設定されます。

ActivityA (または ActivityB) がフォアグラウンドに戻ると、プロファイルを ProfileB (または ProfileM) に戻すために、SWITCH_TO_PROFILE が使用されます。

関数プロトタイプ

Intent i = new Intent();
i.setAction("com.symbol.datawedge.api.ACTION");
i.putExtra("com.symbol.datawedge.api.SWITCH_TO_PROFILE", "<profile name>");

パラメータ

ACTION [String]: "com.symbol.datawedge.api.ACTION"

EXTRA_DATA [String]: "com.symbol.datawedge.api.SWITCH_TO_PROFILE"

<プロファイル名>: アクティブなプロファイルとして設定するプロファイル名 (大文字と小文字を区別)。

結果コード

DataWedge は、アプリにインテントエクストラ (SEND_RESULT および COMMAND_IDENTIFIER) が含まれている場合、次のエラーコードを返し、DataWedge の結果インテントメカニズムを使用してアプリで結果を取得できるようにします。以下の例を参照してください。

PROFILE_HAS_APP_ASSOCIATION - エラー
PROFILE_NOT_FOUND - エラー
PROFILE_ALREADY_SET - エラー
PROFILE_NAME_EMPTY - エラー
DATAWEDGE_DISABLED - エラー

詳細については、結果コードガイドも参照してください。

コード例

// define action and data strings
String switchToProfile = "com.symbol.datawedge.api.ACTION";
String extraData = "com.symbol.datawedge.api.SWITCH_TO_PROFILE";

public void onResume() {
        super.onResume();

        // create the intent
        Intent i = new Intent();

        // set the action to perform
        i.setAction(switchToProfile);

        // add additional info
        i.putExtra(extraData, "myProfile");

        // send the intent to DataWedge
        this.sendBroadcast(i);
}

結果コードの生成と受信

コマンドおよび構成インテントパラメータは、結果コードを送信するかどうかを決定します (デフォルトでは無効)。SEND_RESULT を使用する場合は、結果コードと元のインテントを照合するために、COMMAND_IDENTIFIER を使用します。こうしたパラメータの使用方法のサンプルを以下に示します。

注: 使用する API に合わせて、この汎用コードを変更します。

// send the intent
    Intent i = new Intent();
    i.setAction(ACTION);
    i.putExtra("com.symbol.datawedge.api.CREATE_PROFILE", "Profile1");

// request and identify the result code
    i.putExtra("SEND_RESULT","true");
    i.putExtra("COMMAND_IDENTIFIER","123456789");
    this.sendBroadcast(i);

// register to receive the result
    public void onReceive(Context context, Intent intent){

        String command = intent.getStringExtra("COMMAND");
        String commandidentifier = intent.getStringExtra("COMMAND_IDENTIFIER");
        String result = intent.getStringExtra("RESULT");

        Bundle bundle = new Bundle();
        String resultInfo = "";
        if(intent.hasExtra("RESULT_INFO")){
            bundle = intent.getBundleExtra("RESULT_INFO");
            Set<String> keys = bundle.keySet();
            for (String key: keys) {
                resultInfo += key + ": "+bundle.getString(key) + "\n";
            }
        }

        String text = "Command: "+command+"\n" +
                      "Result: " +result+"\n" +
                      "Result Info: " +resultInfo + "\n" +
                      "CID:"+commandidentifier;

        Toast.makeText(context, text, Toast.LENGTH_LONG).show();

    };

指定したプロファイルが存在しない場合、またはアプリケーションにすでに関連付けられている場合、この API 関数は無効になります。

DataWedge にはプロファイルとアクティビティの間に 1 対 1 の関係があり、プロファイルは 1 つのアクティビティにのみ関連付けることができます。プロファイルを初めて作成するときは、そのプロファイルはどのアプリケーションにも関連付けられず、また関連付けられるまでアクティブになりません。このため、関連付けられていないプロファイルを複数作成できます。

この API 関数は、このようなプロファイルをアクティブにします。

たとえば、ProfileA が関連付けられておらず、ProfileB がアクティビティ B に関連付けられているとします。アクティビティ A が開始され、SWITCH_TO_PROFILE 関数を使用して ProfileA に切り替えると、アクティビティ A がフォアグラウンドになっている場合、常に ProfileA はアクティブになります。アクティビティ B がフォアグラウンドになると、DataWedge は自動的に ProfileB に切り替わります。

アクティビティ A がフォアグラウンドに戻ると、そのアプリは再度 SWITCH_TO_PROFILE を使用して、ProfileA に切り替える必要があります。これは、アクティビティ A の onResume メソッドで実行されます。

注意事項

アクティビティが一時停止するとプロファイルが自動的に切り替わるため、この API 関数をアクティビティの onResume メソッドから呼び出すことをお勧めします。
あるプロファイルに切り替えた後、この関連付けられていないプロファイルはアプリ/アクティビティに割り当てられず、その後、別のアプリ/アクティビティで使用できるようになります。
後方互換性を保つために、DataWedge の自動プロファイル切り替えは、上記の API コマンドの影響を受けません。そのため、このコマンドは、関連付けられていないプロファイルおよびアプリでのみ機能します。

DataWedge の自動プロファイル切り替えは、次のように機能します。

毎秒...

newProfileId を、現在のフォアグラウンドアクティビティの関連付けられたプロファイル ID に設定します。
関連付けられたプロファイルが見つからない場合は、newProfileId を、現在のフォアグラウンドアプリの関連付けられたプロファイル ID に設定します。
関連付けられたプロファイルが見つからない場合は、newProfileId を、現在のデフォルトプロファイル (Profile0 でない可能性あり) に設定します。
newProfileId と currentProfileId を照合します。異なる場合:
- 現在のプロファイルを非アクティブにします
- 新しいプロファイル (newProfileId) をアクティブにします
- currentProfileId = newProfileId と設定します

関連項目:

Zebra Support Central | インテグレータガイド、製品マニュアル、ソフトウェアダウンロードおよびサポート

LaunchPad | Zebra 開発者コミュニティ

インテント | Android 開発者

インテントおよびインテントフィルタ | Android 開発者

Android インテント | チュートリアル

SWITCH_TO_PROFILE

プロファイルの要約

注意事項

使用方法

関数プロトタイプ

パラメータ

結果コード

コード例

結果コードの生成と受信

コメント

注意事項