モジュールインターフェース

モジュールインターフェースとは、埋め込み時に親モジュールから変数にマッピングできる変数のセットであり、URLから初期化することができます。モジュールインターフェースをWorkshopモジュールのAPIと考えてもよいでしょう。

モジュールインターフェースに変数を追加するには、変数の 設定 パネルに移動し、外部IDを追加し、モジュールインターフェースのトグルが有効になっていることを確認します。オプションとして、モジュールインターフェースの変数に表示名と説明を付けることができます。これらは、モジュールが埋め込まれているか、Open Workshopモジュールイベントで使用されている場合に表示されます。

埋め込みモジュールインターフェース

モジュールを埋め込むと、そのモジュールのモジュールインターフェース変数が利用可能になり、親モジュールの変数を子モジュールインターフェース変数にマップすることができます。これについては、埋め込みモジュールのドキュメンテーション内の インターフェース設定 で詳しく読むことができます。

Open Workshopモジュールイベント

Open Workshopモジュールイベントは、以下に説明するように手動でURLを作成するのを避けるために使用することができます。選択したモジュールのインターフェースが表示され、現在のモジュールから選択したモジュールのインターフェース変数への変数値のパススルーが可能になります。イベントが呼び出されると、URLは現在の値を使用して選択したモジュールを開きます。

モジュールインターフェース変数を含むURLの作成

Open Workshopモジュールイベントの外部では、URLクエリパラメーターの値をモジュールインターフェース変数として使用して、カスタムリンクをアプリケーションの状態に共有するために、URLを手動で動的に生成することができます。その手順は次の通りです：

1. ユーザーのWorkshopアプリにログインします。
2. ブラウザからURLをコピーします。ビューモードになっていて、編集モードではないことを確認してください。このURLは固定されているので、適切な権限を持つ他のユーザーと共有することができます。
3. 編集モードに戻ります。
4. 左側のサイドバーにある Variables メニューを選択します。
5. 新規変数 > String > Static を作成します。
6. 変数の 設定 タブに移動し、外部IDを追加します。
7. ステップ2からのURLに ? を追加し、外部ID、 = 、そして設定したい値を続けて書きます。例えば、 ?interfaceVariable=123 です。他のモジュールインターフェース変数を追加するには、アンパサンド & を続けて、追加の外部ID、イコール = 、値を追加します。

このリンクは、URLで設定された値としてモジュールインターフェース変数を定義し、使用する準備ができています。このリンクは、アクションフォーム、関数、または他の変数変換からの値を使用して、変数変換を使用して動的に生成することができます。

テスト目的で、URLの /latest/ を /dev/ に変更すると、リンクは最後に保存されたWorkshopアプリケーションのバージョンにリダイレクトされます。

Carbonナビゲーション

ここでモジュールインターフェース変数とCarbonナビゲーションの使用について読むことができます。Carbonがサポートする変数の種類にはいくつかの制限があること、そして外部IDはCarbonモジュールタブのパラメーターを設定する際に variable. でプレフィックスを付ける必要があることに注意してください。