CardAction class

Paquete:

botbuilder

Clase Builder para simplificar la adición de acciones a una tarjeta.

Constructores

CardAction(Session)

Crea una nueva cardAction.

Métodos

call(Session, string, TextType)	Realiza una llamada a un número de teléfono. Debe incluir código de país en formato +44/+1 para las llamadas de Skype.
dialogAction(Session, string, string, TextType)	Enlaza un botón o pulsa una acción a una acción con nombre registrada para un cuadro de diálogo o desactiva globalmente el bot. Se puede usar en cualquier lugar donde un postBack sea válido. También puede enlazar estáticamente un botón a una acción para algo como Facebooks Menús persistentes. La carga del botón debe ser action?<action> para acciones sin datos ni action?<action>=<data> para acciones con datos.
displayText(TextType, any[])	(Opcional) texto que se mostrará en la fuente de chat si se hace clic en el botón.
downloadFile(Session, string, TextType)	Descarga el archivo especificado en el dispositivo de usuarios. Actualmente no se admite para Skype.
image(string)	Para que los botones incluyan una imagen junto a la etiqueta de botones. No es compatible con todos los canales.
imBack(Session, string, TextType)	Envía un mensaje al bot para procesarlo de forma que sea visible para todos los miembros de la conversación. Para algunos canales, esto puede asignarse a un postBack.
invoke(Session, string, any, string)
messageBack(Session, string, TextType)	Envía un mensaje al bot para su procesamiento. Un messageBack tiene la capacidad de actuar como un imBack y un postBack.
openUrl(Session, string, TextType)	Abre la dirección URL especificada.
playAudio(Session, string, TextType)	Reproduce el archivo de audio especificado al usuario. Actualmente no se admite para Skype.
playVideo(Session, string, TextType)	Reproduce el vídeo especificado al usuario. Actualmente no se admite para Skype.
postBack(Session, string, TextType)	Envía un mensaje al bot para procesarlo de forma que esté oculto de todos los miembros de la conversación. Para algunos canales, esto puede asignarse a un imBack.
showImage(Session, string, TextType)	Abre la imagen especificada en un visor de imágenes nativo. Para Skype solo es válido como una acción de pulsación en cardImage.
text(TextType, any[])	(Opcional) Texto de esta acción.
title(TextType, any[])	Título de la acción. En el caso de los botones, esta será la etiqueta del botón. Para las acciones de pulsación, se puede usar para fines de accesibilidad o mostrarse al mantener el puntero.
toAction()	Devuelve el CÓDIGO JSON de la acción.
type(string)	Tipo de acción de tarjeta.
value(string)	Valor de acciones.

Detalles del constructor

CardAction(Session)

Crea una nueva cardAction.

new CardAction(session?: Session)

Parámetros

session

Session

(Opcional) se usará para localizar cualquier texto.

Detalles del método

call(Session, string, TextType)

Realiza una llamada a un número de teléfono. Debe incluir código de país en formato +44/+1 para las llamadas de Skype.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

number

string

title

TextType

Devoluciones

CardAction

dialogAction(Session, string, string, TextType)

Enlaza un botón o pulsa una acción a una acción con nombre registrada para un cuadro de diálogo o desactiva globalmente el bot. Se puede usar en cualquier lugar donde un postBack sea válido. También puede enlazar estáticamente un botón a una acción para algo como Facebooks Menús persistentes. La carga del botón debe ser action?<action> para acciones sin datos ni action?<action>=<data> para acciones con datos.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

action

string

Nombre de la acción que se va a invocar cuando se pulsa.

data

string

(Opcional) datos que se pasan a la acción cuando se invocan. La propiedad IRecognizeActionResult.data se puede usar para acceder a estos datos. Si usa beginDialogAction() este valor se pasará como parte de los argumentos iniciales de los diálogos.

title

TextType

(Opcional) título que se asignará al enlazar la acción a un botón.

Devoluciones

CardAction

displayText(TextType, any[])

(Opcional) texto que se mostrará en la fuente de chat si se hace clic en el botón.

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

Parámetros

text

TextType

args

any[]

Devoluciones

CardAction

downloadFile(Session, string, TextType)

Descarga el archivo especificado en el dispositivo de usuarios. Actualmente no se admite para Skype.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

url

string

title

TextType

Devoluciones

CardAction

image(string)

Para que los botones incluyan una imagen junto a la etiqueta de botones. No es compatible con todos los canales.

function image(url: string)

Parámetros

url

string

Devoluciones

CardAction

imBack(Session, string, TextType)

Envía un mensaje al bot para procesarlo de forma que sea visible para todos los miembros de la conversación. Para algunos canales, esto puede asignarse a un postBack.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

msg

string

title

TextType

Devoluciones

CardAction

invoke(Session, string, any, string)

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

Parámetros

session

Session

action

string

data

any

title

string

Devoluciones

CardAction

messageBack(Session, string, TextType)

Envía un mensaje al bot para su procesamiento. Un messageBack tiene la capacidad de actuar como un imBack y un postBack.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

msg

string

title

TextType

Devoluciones

CardAction

openUrl(Session, string, TextType)

Abre la dirección URL especificada.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

url

string

title

TextType

Devoluciones

CardAction

playAudio(Session, string, TextType)

Reproduce el archivo de audio especificado al usuario. Actualmente no se admite para Skype.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

url

string

title

TextType

Devoluciones

CardAction

playVideo(Session, string, TextType)

Reproduce el vídeo especificado al usuario. Actualmente no se admite para Skype.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

url

string

title

TextType

Devoluciones

CardAction

postBack(Session, string, TextType)

Envía un mensaje al bot para procesarlo de forma que esté oculto de todos los miembros de la conversación. Para algunos canales, esto puede asignarse a un imBack.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

msg

string

title

TextType

Devoluciones

CardAction

showImage(Session, string, TextType)

Abre la imagen especificada en un visor de imágenes nativo. Para Skype solo es válido como una acción de pulsación en cardImage.

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

Parámetros

session

Session

(Opcional) Objeto de sesión actual para la conversación. Si se especifica, se usará para localizar títulos.

url

string

title

TextType

Devoluciones

CardAction

text(TextType, any[])

(Opcional) Texto de esta acción.

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

Parámetros

text

TextType

args

any[]

Devoluciones

CardAction

title(TextType, any[])

Título de la acción. En el caso de los botones, esta será la etiqueta del botón. Para las acciones de pulsación, se puede usar para fines de accesibilidad o mostrarse al mantener el puntero.

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

Parámetros

text

TextType

args

any[]

Devoluciones

CardAction

toAction()

Devuelve el CÓDIGO JSON de la acción.

function toAction()

Devoluciones

ICardAction

type(string)

Tipo de acción de tarjeta.

function type(t: string)

Parámetros

t

string

Devoluciones

CardAction

value(string)

Valor de acciones.

function value(v: string)

Parámetros

v

string

Devoluciones

CardAction