CardAction class

Paquet:

botbuilder

Classe Builder pour simplifier l’ajout d’actions à une carte.

Constructeurs

CardAction(Session)

Crée une carte CardAction.

Méthodes

call(Session, string, TextType)	Place un appel à un numéro de téléphone. Le code de pays doit être inclus dans le format +44/+1 pour les appels Skype.
dialogAction(Session, string, string, TextType)	Lie un bouton ou appuyez sur une action nommée inscrite pour une boîte de dialogue ou globalement hors du bot. Peut être utilisé n’importe où un postBack est valide. Vous pouvez également lier statiquement un bouton à une action pour quelque chose comme Facebooks menus persistants. La charge utile du bouton doit être action?<action> pour les actions sans données ni action?<action>=<data> pour les actions avec des données.
displayText(TextType, any[])	(Facultatif) texte à afficher dans le flux de conversation si le bouton est cliqué.
downloadFile(Session, string, TextType)	Télécharge le fichier spécifié sur l’appareil des utilisateurs. Non pris en charge pour Skype.
image(string)	Pour que les boutons incluent une image en regard de l’étiquette des boutons. Non pris en charge par tous les canaux.
imBack(Session, string, TextType)	Envoie un message au bot pour le traitement d’une manière visible par tous les membres de la conversation. Pour certains canaux, cela peut être mappé à un postBack.
invoke(Session, string, any, string)
messageBack(Session, string, TextType)	Envoie un message au bot pour traitement. Un a la possibilité d’agir comme un imBack et un postBack.
openUrl(Session, string, TextType)	Ouvre l’URL spécifiée.
playAudio(Session, string, TextType)	Lit le fichier audio spécifié pour l’utilisateur. Non pris en charge pour Skype.
playVideo(Session, string, TextType)	Lit la vidéo spécifiée pour l’utilisateur. Non pris en charge pour Skype.
postBack(Session, string, TextType)	Envoie un message au bot pour le traitement d’une manière masquée par tous les membres de la conversation. Pour certains canaux, cela peut être mappé à un imBack.
showImage(Session, string, TextType)	Ouvre l’image spécifiée dans une visionneuse d’images native. Pour Skype valide uniquement en tant qu’action d’appui sur un CardImage.
text(TextType, any[])	(Facultatif) Texte de cette action.
title(TextType, any[])	Titre de l’action. Pour les boutons, il s’agit de l’étiquette du bouton. Pour les actions d’appui, cela peut être utilisé à des fins d’accessibilité ou affiché sur le pointage.
toAction()	Retourne le json de l’action.
type(string)	Type d’action de carte.
value(string)	Valeur des actions.

Détails du constructeur

CardAction(Session)

Crée une carte CardAction.

new CardAction(session?: Session)

Paramètres

session

Session

(Facultatif) sera utilisé pour localiser tout texte.

Détails de la méthode

call(Session, string, TextType)

Place un appel à un numéro de téléphone. Le code de pays doit être inclus dans le format +44/+1 pour les appels Skype.

static function call(session: Session, number: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

number

string

title

TextType

Retours

CardAction

dialogAction(Session, string, string, TextType)

Lie un bouton ou appuyez sur une action nommée inscrite pour une boîte de dialogue ou globalement hors du bot. Peut être utilisé n’importe où un postBack est valide. Vous pouvez également lier statiquement un bouton à une action pour quelque chose comme Facebooks menus persistants. La charge utile du bouton doit être action?<action> pour les actions sans données ni action?<action>=<data> pour les actions avec des données.

static function dialogAction(session: Session, action: string, data?: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

action

string

Nom de l’action à appeler en cas d’appui.

data

string

(Facultatif) données à transmettre à l’action lorsqu’elles sont appelées. La propriété IRecognizeActionResult.data peut être utilisée pour accéder à ces données. Si vous utilisez beginDialogAction() cette valeur sera passée dans le cadre des arguments initiaux des dialogues.

title

TextType

(Facultatif) titre à affecter lors de la liaison de l’action à un bouton.

Retours

CardAction

displayText(TextType, any[])

(Facultatif) texte à afficher dans le flux de conversation si le bouton est cliqué.

function displayText(text: TextType, args: any[])

Paramètres

text

TextType

args

any[]

Retours

CardAction

downloadFile(Session, string, TextType)

Télécharge le fichier spécifié sur l’appareil des utilisateurs. Non pris en charge pour Skype.

static function downloadFile(session: Session, url: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

url

string

title

TextType

Retours

CardAction

image(string)

Pour que les boutons incluent une image en regard de l’étiquette des boutons. Non pris en charge par tous les canaux.

function image(url: string)

Paramètres

url

string

Retours

CardAction

imBack(Session, string, TextType)

Envoie un message au bot pour le traitement d’une manière visible par tous les membres de la conversation. Pour certains canaux, cela peut être mappé à un postBack.

static function imBack(session: Session, msg: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

msg

string

title

TextType

Retours

CardAction

invoke(Session, string, any, string)

static function invoke(session: Session, action: string, data: any, title: string)

Paramètres

session

Session

action

string

data

any

title

string

Retours

CardAction

messageBack(Session, string, TextType)

Envoie un message au bot pour traitement. Un a la possibilité d’agir comme un imBack et un postBack.

static function messageBack(session: Session, msg: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

msg

string

title

TextType

Retours

CardAction

openUrl(Session, string, TextType)

Ouvre l’URL spécifiée.

static function openUrl(session: Session, url: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

url

string

title

TextType

Retours

CardAction

playAudio(Session, string, TextType)

Lit le fichier audio spécifié pour l’utilisateur. Non pris en charge pour Skype.

static function playAudio(session: Session, url: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

url

string

title

TextType

Retours

CardAction

playVideo(Session, string, TextType)

Lit la vidéo spécifiée pour l’utilisateur. Non pris en charge pour Skype.

static function playVideo(session: Session, url: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

url

string

title

TextType

Retours

CardAction

postBack(Session, string, TextType)

Envoie un message au bot pour le traitement d’une manière masquée par tous les membres de la conversation. Pour certains canaux, cela peut être mappé à un imBack.

static function postBack(session: Session, msg: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

msg

string

title

TextType

Retours

CardAction

showImage(Session, string, TextType)

Ouvre l’image spécifiée dans une visionneuse d’images native. Pour Skype valide uniquement en tant qu’action d’appui sur un CardImage.

static function showImage(session: Session, url: string, title?: TextType)

Paramètres

session

Session

(Facultatif) Objet de session actif pour la conversation. Si spécifié est utilisé pour localiser les titres.

url

string

title

TextType

Retours

CardAction

text(TextType, any[])

(Facultatif) Texte de cette action.

function text(text: TextType, args: any[])

Paramètres

text

TextType

args

any[]

Retours

CardAction

title(TextType, any[])

Titre de l’action. Pour les boutons, il s’agit de l’étiquette du bouton. Pour les actions d’appui, cela peut être utilisé à des fins d’accessibilité ou affiché sur le pointage.

function title(text: TextType, args: any[])

Paramètres

text

TextType

args

any[]

Retours

CardAction

toAction()

Retourne le json de l’action.

function toAction()

Retours

ICardAction

type(string)

Type d’action de carte.

function type(t: string)

Paramètres

t

string

Retours

CardAction

value(string)

Valeur des actions.

function value(v: string)

Paramètres

v

string

Retours

CardAction