MessageFactory class
Un set di funzioni di utilità per facilitare la formattazione dei vari tipi di messaggio che un bot può restituire.
Commenti
L'esempio seguente mostra l'invio di un messaggio contenente una singola scheda hero:
const { MessageFactory, CardFactory } = require('botbuilder');
const card = CardFactory.heroCard(
'White T-Shirt',
['https://example.com/whiteShirt.jpg'],
['buy']
);
const message = MessageFactory.attachment(card);
await context.sendActivity(message);
Metodi
| attachment(Attachment, string, string, Input |
Restituisce una singola attività di messaggio contenente un allegato. |
| carousel(Attachment[], string, string, Input |
Restituisce un messaggio che visualizzerà un set di allegati utilizzando un layout carousel. |
| content |
Restituisce un messaggio che visualizzerà una singola immagine o video a un utente. |
| list(Attachment[], string, string, Input |
Restituisce un messaggio che visualizzerà un set di allegati in formato elenco. |
| suggested |
Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo. |
| text(string, string, Input |
Restituisce un semplice messaggio di testo. |
Dettagli metodo
attachment(Attachment, string, string, InputHints | string)
Restituisce una singola attività di messaggio contenente un allegato.
static function attachment(attachment: Attachment, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- attachment
-
Attachment
Scheda adattiva da includere nel messaggio.
- text
-
string
(Facoltativo) testo del messaggio.
- speak
-
string
(Facoltativo) SSML da includere con il messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio. Il valore predefinito è acceptingInput.
Restituisce
Partial<Activity>
Attività di messaggio contenente l'allegato.
Commenti
Questo esempio mostra la creazione di un messaggio con un allegato della scheda hero:
const message = MessageFactory.attachment(
CardFactory.heroCard(
'White T-Shirt',
['https://example.com/whiteShirt.jpg'],
['buy']
)
);
carousel(Attachment[], string, string, InputHints | string)
Restituisce un messaggio che visualizzerà un set di allegati utilizzando un layout carousel.
static function carousel(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- attachments
-
Attachment[]
Matrice di allegati da includere nel messaggio.
- text
-
string
(Facoltativo) testo del messaggio.
- speak
-
string
(Facoltativo) SSML da includere con il messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio.
Restituisce
Partial<Activity>
Attività di messaggio che visualizzerà un set di allegati usando un layout carousel.
Commenti
Questo esempio mostra la creazione di un messaggio con una sequenza di schede hero:
const message = MessageFactory.carousel([
CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);
contentUrl(string, string, string, string, string, InputHints | string)
Restituisce un messaggio che visualizzerà una singola immagine o video a un utente.
static function contentUrl(url: string, contentType: string, name?: string, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- url
-
string
URL dell'immagine/video da inviare.
- contentType
-
string
Tipo MIME dell'immagine/video.
- name
-
string
(Facoltativo) Nome del file image/video.
- text
-
string
(Facoltativo) testo del messaggio.
- speak
-
string
(Facoltativo) SSML da includere con il messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio.
Restituisce
Partial<Activity>
Attività di messaggio che visualizzerà una singola immagine o video a un utente.
Commenti
Questo esempio mostra l'invio di un'immagine all'utente:
const message = MessageFactory.contentUrl('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.');
list(Attachment[], string, string, InputHints | string)
Restituisce un messaggio che visualizzerà un set di allegati in formato elenco.
static function list(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- attachments
-
Attachment[]
Matrice di allegati da includere nel messaggio.
- text
-
string
(Facoltativo) testo del messaggio.
- speak
-
string
(Facoltativo) SSML da includere con il messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio.
Restituisce
Partial<Activity>
Attività di messaggio che visualizzerà un set di allegati nel modulo elenco.
Commenti
Questo esempio mostra la creazione di un messaggio con un elenco di schede hero:
const message = MessageFactory.list([
CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);
suggestedActions(string | CardAction[], string, string, InputHints | string)
Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.
static function suggestedActions(actions: string | CardAction[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- actions
-
string | CardAction[]
Matrice di azioni scheda o stringhe da includere. Le stringhe verranno convertite in azioni di messageBack.
- text
-
string
(Facoltativo) testo del messaggio.
- speak
-
string
(Facoltativo) SSML da includere con il messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio. Il valore predefinito è acceptingInput.
Restituisce
Partial<Activity>
Attività di messaggio che contiene le azioni suggerite.
Commenti
Questo esempio mostra la creazione di un messaggio con azioni suggerite:
const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], `Choose a color`);
text(string, string, InputHints | string)
Restituisce un semplice messaggio di testo.
static function text(text: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>Parametri
- text
-
string
Testo da includere nel messaggio.
- speak
-
string
(Facoltativo) SSML da includere nel messaggio.
- inputHint
-
InputHints | string
(Facoltativo) hint di input per il messaggio. Il valore predefinito è acceptingInput.
Restituisce
Partial<Activity>
Attività di messaggio contenente il testo.
Commenti
Questo esempio mostra l'invio di un semplice sms:
const message = MessageFactory.text('Greetings from example message');