MessageFactory Classe

Um conjunto de funções de utilitário projetadas para ajudar na formatação dos vários tipos de mensagem que um bot pode retornar.

Construtor

MessageFactory()

Métodos

attachment

Retorna uma única atividade de mensagem que contém um anexo.

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

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

content_url

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

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

Retorna uma mensagem que exibirá um conjunto de anexos no formulário 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

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')], 'Choose a color')

await context.send_activity(message)

text

Retorna uma mensagem de texto simples.

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

attachment

Retorna uma única atividade de mensagem que contém um anexo.

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

Nome Description
attachment
Obrigatório
text
Valor padrão: None
speak
Valor padrão: None
input_hint
Valor padrão: 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(message)

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

Parâmetros

Nome Description
attachments
Obrigatório
text
Valor padrão: None
speak
Valor padrão: None
input_hint
Valor padrão: None

content_url

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

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

Nome Description
url
Obrigatório
content_type
Obrigatório
name
Valor padrão: None
text
Valor padrão: None
speak
Valor padrão: None
input_hint
Valor padrão: None

list

Retorna uma mensagem que exibirá um conjunto de anexos no formulário 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

Nome Description
attachments
Obrigatório
text
Valor padrão: None
speak
Valor padrão: None
input_hint
Valor padrão: 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')], '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

Nome Description
actions
Obrigatório
text
Valor padrão: None
speak
Valor padrão: None
input_hint
Valor padrão: InputHints.accepting_input

text

Retorna uma mensagem de texto simples.

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

Nome Description
text
Obrigatório
speak
Valor padrão: None
input_hint
Valor padrão: InputHints.accepting_input