MessageFactory Klasse

Eine Reihe von Hilfsfunktionen zur Unterstützung der Formatierung der verschiedenen Nachrichtentypen, die ein Bot zurückgeben kann.

Konstruktor

MessageFactory()

Methoden

attachment

Gibt eine einzelne Nachrichtenaktivität zurück, die eine Anlage enthält.

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

Gibt eine Nachricht zurück, die eine Gruppe von Anlagen mithilfe eines Karusselllayouts anzeigt.

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

Gibt eine Nachricht zurück, die einem Benutzer ein einzelnes Bild oder Video anzeigt.

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

Gibt eine Nachricht zurück, die eine Gruppe von Anlagen im Listenformular anzeigt.

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

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.

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

Gibt eine einfache Textnachricht zurück.

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

attachment

Gibt eine einzelne Nachrichtenaktivität zurück, die eine Anlage enthält.

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)

Parameter

Name Beschreibung
attachment
Erforderlich
text
Standardwert: None
speak
Standardwert: None
input_hint
Standardwert: None

Gibt eine Nachricht zurück, die eine Gruppe von Anlagen mithilfe eines Karusselllayouts anzeigt.

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

Parameter

Name Beschreibung
attachments
Erforderlich
text
Standardwert: None
speak
Standardwert: None
input_hint
Standardwert: None

content_url

Gibt eine Nachricht zurück, die einem Benutzer ein einzelnes Bild oder Video anzeigt.

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)

Parameter

Name Beschreibung
url
Erforderlich
content_type
Erforderlich
name
Standardwert: None
text
Standardwert: None
speak
Standardwert: None
input_hint
Standardwert: None

list

Gibt eine Nachricht zurück, die eine Gruppe von Anlagen im Listenformular anzeigt.

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

Parameter

Name Beschreibung
attachments
Erforderlich
text
Standardwert: None
speak
Standardwert: None
input_hint
Standardwert: None

suggested_actions

Gibt eine Nachricht zurück, die eine Reihe von vorgeschlagenen Aktionen und optionalen Text enthält.

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

Parameter

Name Beschreibung
actions
Erforderlich
text
Standardwert: None
speak
Standardwert: None
input_hint
Standardwert: InputHints.accepting_input

text

Gibt eine einfache Textnachricht zurück.

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

Parameter

Name Beschreibung
text
Erforderlich
speak
Standardwert: None
input_hint
Standardwert: InputHints.accepting_input