xApp: HTML を表示

説明

xApp ページは、カスタム HTML コードを提供することで構築できます。

さらにカスタマイズするための代替手段として、拡張機能を実装してアップロードすることで独自のノードを作成できます。

コンテンツ

HTML ドキュメントを指定することも、HTML 本文のみを指定することもできます。 このノードが実行されると、この xApp ページが xApp セッションに表示されます。

HTML コード内で、グローバル SDK 変数を介して xApp ページ SDK にアクセスできます。 結果をフローに送信するには、SDK.submit({ name: “”””John”””” }); を呼び出します。 送信されるペイロードは、JSON シリアル化可能なオブジェクトである必要があります。

送信機能を利用することができます。 クリック時に送信するボタンの例は、 のようになります。

送信されたデータを表示するには、[インタラクション] パネルを使用します。 データ オブジェクト内の送信されたデータにアクセスするには、[情報] > [入力] をクリックするか、チャットで Say Node を追加し、送信ペイロード: {{JSON.stringify(input.data)}} または送信ペイロード: {{JSON.stringify) を指定します。 (ci.data)}}。

HTML コード内からセッション データにアクセスするには、CognigyScript {{ JSON.stringify(cc.someContextKey) }} を使用します。

待機行動

たとえば、ユーザーが「注文」ページで「送信」をクリックしたときなど、ユーザー入力を待つには、「待機動作」オプションをアクティブにします。 入力結果をContextに保存し、そのデータを他のNodeで利用することができます。

xApp ページ SDK

Cognigy 内でホストされている場合、xApp ページ (または任意の汎用 HTML xApp) は、固定 URL: を使用して xApp ページ SDK をロードできます。 このファイルをロードすると、xApp Page SDK が SDK というグローバル インスタンスとして公開されます。 そのメソッドにアクセスするには、SDK ファイルをロードした後、コード内で SDK.someExampleMethod() を呼び出します。 SDK コードは非同期的にロードされないことに注意してください。

機能使い方
SDK.getAppTemplateData():Promise<unknown>この xApp ページに関連付けられた xApp テンプレート データを返します。
SDK.submit(result: Object):Promise<void>提供された「結果」オブジェクトをフローに送信します。 JSON シリアル化可能なオブジェクトである必要があります。
SDK.getCustomReadyHandler():Functionカスタムの準備完了状態ハンドラーを返します。デフォルトでは、ドキュメントが完全に読み込まれるとすぐに xApp ページの準備が整います。
ページを表示する前に追加のコンテンツを取得したい場合は、カスタム Ready ハンドラーを取得し、xApp ページの準備ができたらすぐにそれを手動で呼び出すことで、ready イベントをオーバーライドできます。
エンド ユーザーには、シェル ページに xApp 読み込み画面が表示されます。
注: xApp ページのロードに 10 秒以上かかる場合、xApp はロードに失敗したものとして扱われ、回復する可能性はありません。

詳しくはこちら