MessageFactory Classe

Um conjunto de funções utilitárias projetadas para ajudar com a formatação dos vários tipos de mensagens que um bot pode retornar.

Construtor

MessageFactory()

Métodos

attachment

Retorna uma única atividade de mensagem contendo um anexo.

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

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

await context.send_activity(mensagem)

carousel

Retorna uma mensagem que exibirá um conjunto de anexos usando um layout de carrossel.

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(mensagem)

content_url

Retorna uma mensagem que exibirá uma única imagem ou vídeo para um usuário.

mensagem = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'Uma foto de nossas férias em família.')

await context.send_activity(mensagem)

list

Retorna uma mensagem que exibirá um conjunto de anexos em forma de lista.

mensagem = 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(mensagem)

suggested_actions

Retorna uma mensagem que inclui um conjunto de ações sugeridas e 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')], 'Escolha uma cor')

await context.send_activity(mensagem)

text

Retorna uma mensagem de texto simples.

message = MessageFactory.text('Saudações da mensagem de exemplo') await context.send_activity(message)

attachment

Retorna uma única atividade de mensagem contendo um anexo.

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

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

await context.send_activity(mensagem)

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

Parâmetros

Name Description
attachment
Necessário
text
Default value: None
speak
Default value: None
input_hint
Default value: None

Retorna uma mensagem que exibirá um conjunto de anexos usando um layout de carrossel.

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(mensagem)

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

Parâmetros

Name Description
attachments
Necessário
text
Default value: None
speak
Default value: None
input_hint
Default value: None

content_url

Retorna uma mensagem que exibirá uma única imagem ou vídeo para um usuário.

mensagem = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'Uma foto de nossas férias em família.')

await context.send_activity(mensagem)

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

Parâmetros

Name Description
url
Necessário
content_type
Necessário
name
Default value: None
text
Default value: None
speak
Default value: None
input_hint
Default value: None

list

Retorna uma mensagem que exibirá um conjunto de anexos em forma de lista.

mensagem = 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(mensagem)

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

Parâmetros

Name Description
attachments
Necessário
text
Default value: None
speak
Default value: None
input_hint
Default value: None

suggested_actions

Retorna uma mensagem que inclui um conjunto de ações sugeridas e 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')], 'Escolha uma cor')

await context.send_activity(mensagem)

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

Parâmetros

Name Description
actions
Necessário
text
Default value: None
speak
Default value: None
input_hint
Default value: InputHints.accepting_input

text

Retorna uma mensagem de texto simples.

message = MessageFactory.text('Saudações da mensagem de exemplo') await context.send_activity(message)

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

Parâmetros

Name Description
text
Necessário
speak
Default value: None
input_hint
Default value: InputHints.accepting_input