MessageFactory Clase

Un conjunto de funciones de utilidad diseñadas para ayudar con el formato de los distintos tipos de mensajes que puede devolver un bot.

Constructor

MessageFactory()

Métodos

attachment

Devuelve una actividad de mensaje única que contiene datos adjuntos.

message = MessageFactory.attachment(CardFactory.hero_card(HeroCard(title='White T-Shirt', images=[CardImage(url= 'https://example.com/whiteShirt.jpg' )],

buttons=[CardAction(title='buy')])))

await context.send_activity(message)

carousel

Devuelve un mensaje que mostrará un conjunto de datos adjuntos mediante un diseño de carrusel.

message = MessageFactory.carousel([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])),

CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')])),

CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')])])

await context.send_activity(message)

content_url

Devuelve un mensaje que mostrará una sola imagen o vídeo a un usuario.

message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.')

await context.send_activity(message)

list

Devuelve un mensaje que mostrará un conjunto de datos adjuntos en el formulario de lista.

message = MessageFactory.list([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])),

CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')])),

CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')])])

await context.send_activity(message)

suggested_actions

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.

message = MessageFactory.suggested_actions([CardAction(title='a', type=ActionTypes.im_back, value='a'), CardAction(title='b', type=ActionTypes.im_back, value='b'), CardAction(title='c', type=ActionTypes.im_back, value='c')], 'Choose a color')

await context.send_activity(message)

text

Devuelve un mensaje de texto simple.

message = MessageFactory.text('Greetings from example message') await context.send_activity(message)

attachment

Devuelve una actividad de mensaje única que contiene datos adjuntos.

message = MessageFactory.attachment(CardFactory.hero_card(HeroCard(title='White T-Shirt', images=[CardImage(url= 'https://example.com/whiteShirt.jpg' )],

buttons=[CardAction(title='buy')])))

await context.send_activity(message)

static attachment(attachment: Attachment, text: str = None, speak: str = None, input_hint: InputHints | str = None)

Parámetros

Nombre Description
attachment
Requerido
text
Valor predeterminado: None
speak
Valor predeterminado: None
input_hint
Valor predeterminado: None

Devuelve un mensaje que mostrará un conjunto de datos adjuntos mediante un diseño de carrusel.

message = MessageFactory.carousel([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])),

CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')])),

CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')])])

await context.send_activity(message)

static carousel(attachments: List[Attachment], text: str = None, speak: str = None, input_hint: InputHints | str = None) -> Activity

Parámetros

Nombre Description
attachments
Requerido
text
Valor predeterminado: None
speak
Valor predeterminado: None
input_hint
Valor predeterminado: None

content_url

Devuelve un mensaje que mostrará una sola imagen o vídeo a un usuario.

message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.')

await context.send_activity(message)

static content_url(url: str, content_type: str, name: str = None, text: str = None, speak: str = None, input_hint: InputHints | str = None)

Parámetros

Nombre Description
url
Requerido
content_type
Requerido
name
Valor predeterminado: None
text
Valor predeterminado: None
speak
Valor predeterminado: None
input_hint
Valor predeterminado: None

list

Devuelve un mensaje que mostrará un conjunto de datos adjuntos en el formulario de lista.

message = MessageFactory.list([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])),

CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')])),

CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')])])

await context.send_activity(message)

static list(attachments: List[Attachment], text: str = None, speak: str = None, input_hint: InputHints | str = None) -> Activity

Parámetros

Nombre Description
attachments
Requerido
text
Valor predeterminado: None
speak
Valor predeterminado: None
input_hint
Valor predeterminado: None

suggested_actions

Devuelve un mensaje que incluye un conjunto de acciones sugeridas y texto opcional.

message = MessageFactory.suggested_actions([CardAction(title='a', type=ActionTypes.im_back, value='a'), CardAction(title='b', type=ActionTypes.im_back, value='b'), CardAction(title='c', type=ActionTypes.im_back, value='c')], 'Choose a color')

await context.send_activity(message)

static suggested_actions(actions: List[CardAction], text: str = None, speak: str = None, input_hint: InputHints | str = InputHints.accepting_input) -> Activity

Parámetros

Nombre Description
actions
Requerido
text
Valor predeterminado: None
speak
Valor predeterminado: None
input_hint
Valor predeterminado: InputHints.accepting_input

text

Devuelve un mensaje de texto simple.

message = MessageFactory.text('Greetings from example message') await context.send_activity(message)

static text(text: str, speak: str = None, input_hint: InputHints | str = InputHints.accepting_input) -> Activity

Parámetros

Nombre Description
text
Requerido
speak
Valor predeterminado: None
input_hint
Valor predeterminado: InputHints.accepting_input