CardAction class
カードへのアクションの追加を簡略化する Builder クラス。
コンストラクター
| Card |
新しい CardAction を作成します。 |
メソッド
| call(Session, string, Text |
電話番号に通話を発信します。 Skype 通話には、+44/+1 形式の国コードを含める必要があります。 |
| dialog |
ボタンまたはタップ アクションを、ダイアログに登録されている名前付きアクションまたはボットからグローバルにバインドします。
postBack が有効な任意の場所で使用できます。 また、Facebooks 永続的メニューなどのアクションにボタンを静的にバインドすることもできます。
ボタンのペイロードは、データのないアクションの場合は |
| display |
(省略可能) ボタンがクリックされた場合にチャット フィードに表示するテキスト。 |
| download |
指定したファイルをユーザー デバイスにダウンロードします。 現在、Skype ではサポートされていません。 |
| image(string) | ボタンの場合、ボタン ラベルの横に画像を含めます。 すべてのチャネルでサポートされているわけではありません。 |
| im |
会話のすべてのメンバーに表示される方法で処理するためのメッセージをボットに送信します。 一部のチャネルでは、これは postBackにマップされることがあります。 |
| invoke(Session, string, any, string) | |
| message |
処理のためにボットにメッセージを送信します。
|
| open |
指定した URL を開きます。 |
| play |
指定したオーディオ ファイルをユーザーに再生します。 現在、Skype ではサポートされていません。 |
| play |
指定したビデオをユーザーに再生します。 現在、Skype ではサポートされていません。 |
| post |
メッセージをボットに送信し、会話のすべてのメンバーから隠された方法で処理します。 一部のチャネルでは、これは imBackにマップされることがあります。 |
| show |
ネイティブ イメージ ビューアーで指定したイメージを開きます。 Skype の場合は、CardImage のタップ アクションとしてのみ有効です。 |
| text(Text |
(省略可能)このアクションのテキスト。 |
| title(Text |
アクションのタイトル。 ボタンの場合、これはボタンのラベルになります。 タップ アクションの場合、これはアクセスの目的で使用することも、ホバー時に表示することもできます。 |
| to |
アクションの JSON を返します。 |
| type(string) | カード アクションの種類。 |
| value(string) | アクションの値。 |
コンストラクターの詳細
CardAction(Session)
新しい CardAction を作成します。
new CardAction(session?: Session)
パラメーター
- session
- Session
(省略可能) は、任意のテキストをローカライズするために使用されます。
メソッドの詳細
call(Session, string, TextType)
電話番号に通話を発信します。 Skype 通話には、+44/+1 形式の国コードを含める必要があります。
static function call(session: Session, number: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- number
-
string
- title
- TextType
戻り値
dialogAction(Session, string, string, TextType)
ボタンまたはタップ アクションを、ダイアログに登録されている名前付きアクションまたはボットからグローバルにバインドします。
postBack が有効な任意の場所で使用できます。 また、Facebooks 永続的メニューなどのアクションにボタンを静的にバインドすることもできます。
ボタンのペイロードは、データのないアクションの場合は action?<action>、データを含むアクションには action?<action>=<data> する必要があります。
static function dialogAction(session: Session, action: string, data?: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- action
-
string
タップしたときに呼び出すアクションの名前。
- data
-
string
(省略可能) 呼び出されたときにアクションに渡すデータ。 IRecognizeActionResult.data プロパティを使用して、このデータにアクセスできます。 beginDialogAction() 使用 場合、この値はダイアログの初期引数の一部として渡されます。
- title
- TextType
(省略可能) アクションをボタンにバインドするときに割り当てるタイトル。
戻り値
displayText(TextType, any[])
(省略可能) ボタンがクリックされた場合にチャット フィードに表示するテキスト。
function displayText(text: TextType, args: any[])
パラメーター
- text
- TextType
- args
-
any[]
戻り値
downloadFile(Session, string, TextType)
指定したファイルをユーザー デバイスにダウンロードします。 現在、Skype ではサポートされていません。
static function downloadFile(session: Session, url: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- url
-
string
- title
- TextType
戻り値
image(string)
ボタンの場合、ボタン ラベルの横に画像を含めます。 すべてのチャネルでサポートされているわけではありません。
function image(url: string)
パラメーター
- url
-
string
戻り値
imBack(Session, string, TextType)
会話のすべてのメンバーに表示される方法で処理するためのメッセージをボットに送信します。 一部のチャネルでは、これは postBackにマップされることがあります。
static function imBack(session: Session, msg: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- msg
-
string
- title
- TextType
戻り値
invoke(Session, string, any, string)
static function invoke(session: Session, action: string, data: any, title: string)
パラメーター
- session
- Session
- action
-
string
- data
-
any
- title
-
string
戻り値
messageBack(Session, string, TextType)
処理のためにボットにメッセージを送信します。
messageBack には、imBack と postBackの両方のように動作する機能があります。
static function messageBack(session: Session, msg: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- msg
-
string
- title
- TextType
戻り値
openUrl(Session, string, TextType)
指定した URL を開きます。
static function openUrl(session: Session, url: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- url
-
string
- title
- TextType
戻り値
playAudio(Session, string, TextType)
指定したオーディオ ファイルをユーザーに再生します。 現在、Skype ではサポートされていません。
static function playAudio(session: Session, url: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- url
-
string
- title
- TextType
戻り値
playVideo(Session, string, TextType)
指定したビデオをユーザーに再生します。 現在、Skype ではサポートされていません。
static function playVideo(session: Session, url: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- url
-
string
- title
- TextType
戻り値
postBack(Session, string, TextType)
メッセージをボットに送信し、会話のすべてのメンバーから隠された方法で処理します。 一部のチャネルでは、これは imBackにマップされることがあります。
static function postBack(session: Session, msg: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- msg
-
string
- title
- TextType
戻り値
showImage(Session, string, TextType)
ネイティブ イメージ ビューアーで指定したイメージを開きます。 Skype の場合は、CardImage のタップ アクションとしてのみ有効です。
static function showImage(session: Session, url: string, title?: TextType)
パラメーター
- session
- Session
(省略可能)会話の現在のセッション オブジェクト。 指定した場合は、タイトルをローカライズするために使用されます。
- url
-
string
- title
- TextType
戻り値
text(TextType, any[])
title(TextType, any[])
アクションのタイトル。 ボタンの場合、これはボタンのラベルになります。 タップ アクションの場合、これはアクセスの目的で使用することも、ホバー時に表示することもできます。
function title(text: TextType, args: any[])
パラメーター
- text
- TextType
- args
-
any[]