CardAction class

Pacchetto:

botbuilder

Classe Builder per semplificare l'aggiunta di azioni a una scheda.

Costruttori

CardAction(Session)

Crea un nuovo oggetto CardAction.

Metodi

call(Session, string, TextType)	Effettua una chiamata a un numero di telefono. Deve includere il codice paese in formato +44/+1 per le chiamate Skype.
dialogAction(Session, string, string, TextType)	Associa un pulsante o un'azione di tocco a un'azione denominata registrata per una finestra di dialogo o a livello globale dal bot. Può essere usato ovunque sia valido un postBack. È anche possibile associare staticamente un pulsante a un'azione per qualcosa come Facebook Menu permanenti. Il payload per il pulsante deve essere action?<action> per le azioni senza dati o action?<action>=<data> per azioni con dati.
displayText(TextType, any[])	(Facoltativo) testo da visualizzare nel feed di chat se si fa clic sul pulsante.
downloadFile(Session, string, TextType)	Scarica il file specificato nel dispositivo degli utenti. Attualmente non supportato per Skype.
image(string)	Per i pulsanti che un'immagine deve includere accanto all'etichetta dei pulsanti. Non supportato da tutti i canali.
imBack(Session, string, TextType)	Invia un messaggio al bot per l'elaborazione in modo che sia visibile a tutti i membri della conversazione. Per alcuni canali, è possibile eseguire il mapping a un postBack .
invoke(Session, string, any, string)
messageBack(Session, string, TextType)	Invia un messaggio al bot per l'elaborazione. Un messageBack ha la possibilità di agire come un imBack e un postBack .
openUrl(Session, string, TextType)	Apre l'URL specificato.
playAudio(Session, string, TextType)	Riproduce il file audio specificato all'utente. Attualmente non supportato per Skype.
playVideo(Session, string, TextType)	Riproduce il video specificato all'utente. Attualmente non supportato per Skype.
postBack(Session, string, TextType)	Invia un messaggio al bot per l'elaborazione in modo che sia nascosto a tutti i membri della conversazione. Per alcuni canali, è possibile eseguire il mapping a un imBack.
showImage(Session, string, TextType)	Apre l'immagine specificata in un visualizzatore di immagini native. Per Skype valido solo come azione di tocco su cardImage.
text(TextType, any[])	(Facoltativo) Testo per questa azione.
title(TextType, any[])	Titolo dell'azione. Per i pulsanti questa sarà l'etichetta del pulsante. Per le azioni di tocco, questo può essere usato per scopi di accessibilità o visualizzato al passaggio del mouse.
toAction()	Restituisce il codice JSON per l'azione.
type(string)	Tipo di azione della scheda.
value(string)	Valore delle azioni.

Dettagli costruttore

CardAction(Session)

Crea un nuovo oggetto CardAction.

new CardAction(session?: Session)

Parametri

session

Session

(Facoltativo) verrà usato per localizzare qualsiasi testo.

Dettagli metodo

call(Session, string, TextType)

Effettua una chiamata a un numero di telefono. Deve includere il codice paese in formato +44/+1 per le chiamate Skype.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

number

string

title

TextType

Restituisce

CardAction

dialogAction(Session, string, string, TextType)

Associa un pulsante o un'azione di tocco a un'azione denominata registrata per una finestra di dialogo o a livello globale dal bot. Può essere usato ovunque sia valido un postBack. È anche possibile associare staticamente un pulsante a un'azione per qualcosa come Facebook Menu permanenti. Il payload per il pulsante deve essere action?<action> per le azioni senza dati o action?<action>=<data> per azioni con dati.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

action

string

Nome dell'azione da richiamare quando viene toccato.

data

string

(Facoltativo) dati da passare all'azione quando richiamati. La proprietà IRecognizeActionResult.data può essere usata per accedere a questi dati. Se si usa beginDialogAction() questo valore verrà passato come parte degli argomenti iniziali dei dialoghi.

title

TextType

(Facoltativo) titolo da assegnare quando si associa l'azione a un pulsante.

Restituisce

CardAction

displayText(TextType, any[])

(Facoltativo) testo da visualizzare nel feed di chat se si fa clic sul pulsante.

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

Parametri

text

TextType

args

any[]

Restituisce

CardAction

downloadFile(Session, string, TextType)

Scarica il file specificato nel dispositivo degli utenti. Attualmente non supportato per Skype.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

url

string

title

TextType

Restituisce

CardAction

image(string)

Per i pulsanti che un'immagine deve includere accanto all'etichetta dei pulsanti. Non supportato da tutti i canali.

function image(url: string)

Parametri

url

string

Restituisce

CardAction

imBack(Session, string, TextType)

Invia un messaggio al bot per l'elaborazione in modo che sia visibile a tutti i membri della conversazione. Per alcuni canali, è possibile eseguire il mapping a un postBack .

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

msg

string

title

TextType

Restituisce

CardAction

invoke(Session, string, any, string)

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

Parametri

session

Session

action

string

data

any

title

string

Restituisce

CardAction

messageBack(Session, string, TextType)

Invia un messaggio al bot per l'elaborazione. Un messageBack ha la possibilità di agire come un imBack e un postBack .

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

msg

string

title

TextType

Restituisce

CardAction

openUrl(Session, string, TextType)

Apre l'URL specificato.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

url

string

title

TextType

Restituisce

CardAction

playAudio(Session, string, TextType)

Riproduce il file audio specificato all'utente. Attualmente non supportato per Skype.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

url

string

title

TextType

Restituisce

CardAction

playVideo(Session, string, TextType)

Riproduce il video specificato all'utente. Attualmente non supportato per Skype.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

url

string

title

TextType

Restituisce

CardAction

postBack(Session, string, TextType)

Invia un messaggio al bot per l'elaborazione in modo che sia nascosto a tutti i membri della conversazione. Per alcuni canali, è possibile eseguire il mapping a un imBack.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

msg

string

title

TextType

Restituisce

CardAction

showImage(Session, string, TextType)

Apre l'immagine specificata in un visualizzatore di immagini native. Per Skype valido solo come azione di tocco su cardImage.

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

Parametri

session

Session

(Facoltativo) Oggetto sessione corrente per la conversazione. Se specificato verrà usato per localizzare i titoli.

url

string

title

TextType

Restituisce

CardAction

text(TextType, any[])

(Facoltativo) Testo per questa azione.

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

Parametri

text

TextType

args

any[]

Restituisce

CardAction

title(TextType, any[])

Titolo dell'azione. Per i pulsanti questa sarà l'etichetta del pulsante. Per le azioni di tocco, questo può essere usato per scopi di accessibilità o visualizzato al passaggio del mouse.

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

Parametri

text

TextType

args

any[]

Restituisce

CardAction

toAction()

Restituisce il codice JSON per l'azione.

function toAction()

Restituisce

ICardAction

type(string)

Tipo di azione della scheda.

function type(t: string)

Parametri

t

string

Restituisce

CardAction

value(string)

Valore delle azioni.

function value(v: string)

Parametri

v

string

Restituisce

CardAction