MessageFactory Classe

Un set di funzioni di utilità progettate per facilitare la formattazione dei vari tipi di messaggio che un bot può restituire.

Costruttore

MessageFactory()

Metodi

attachment

Restituisce una singola attività di messaggio contenente un allegato.

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

Restituisce un messaggio che visualizzerà un set di allegati utilizzando un layout carousel.

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

Restituisce un messaggio che visualizzerà una singola immagine o video a un utente.

message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Viaggio hawaii', 'Una foto della nostra vacanza in famiglia')

await context.send_activity(message)

list

Restituisce un messaggio che visualizzerà un set di allegati in formato elenco.

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

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.

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

Restituisce un semplice messaggio di testo.

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

attachment

Restituisce una singola attività di messaggio contenente un allegato.

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)

Parametri

Nome Descrizione
attachment
Necessario
text
Valore predefinito: None
speak
Valore predefinito: None
input_hint
Valore predefinito: None

Restituisce un messaggio che visualizzerà un set di allegati utilizzando un layout carousel.

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

Parametri

Nome Descrizione
attachments
Necessario
text
Valore predefinito: None
speak
Valore predefinito: None
input_hint
Valore predefinito: None

content_url

Restituisce un messaggio che visualizzerà una singola immagine o video a un utente.

message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Viaggio hawaii', 'Una foto della nostra vacanza in famiglia')

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)

Parametri

Nome Descrizione
url
Necessario
content_type
Necessario
name
Valore predefinito: None
text
Valore predefinito: None
speak
Valore predefinito: None
input_hint
Valore predefinito: None

list

Restituisce un messaggio che visualizzerà un set di allegati in formato elenco.

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

Parametri

Nome Descrizione
attachments
Necessario
text
Valore predefinito: None
speak
Valore predefinito: None
input_hint
Valore predefinito: None

suggested_actions

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.

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

Parametri

Nome Descrizione
actions
Necessario
text
Valore predefinito: None
speak
Valore predefinito: None
input_hint
Valore predefinito: InputHints.accepting_input

text

Restituisce un semplice messaggio di testo.

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

Parametri

Nome Descrizione
text
Necessario
speak
Valore predefinito: None
input_hint
Valore predefinito: InputHints.accepting_input