IMessage interface

Pacchetto:

botbuilder

Messaggio di chat inviato tra un utente e un bot. I messaggi dal bot all'utente sono disponibili in due versioni:

• messaggi reattivi sono messaggi inviati dal bot all'utente come risposta a un messaggio in arrivo dall'utente.
• messaggi proattivi sono messaggi inviati dal bot all'utente in risposta a un evento esterno, ad esempio l'attivazione di un allarme.

Nel caso reattivo, è necessario copiare il campo indirizzo di dal messaggio in arrivo al messaggio in uscita (se si usa la classe generatore messaggio e inizializzarla con la sessione di che verrà eseguita automaticamente) e quindi impostare il testo o gli allegati . Per i messaggi proattivi è necessario salvare l'indirizzo dal messaggio in arrivo in un archivio esterno. Successivamente è possibile passarlo a UniversalBot.beginDialog() o copiarlo in un messaggio in uscita passato a UniversalBot.send().

La composizione di un messaggio all'utente tramite l'oggetto indirizzo in ingresso invierà per impostazione predefinita una risposta all'utente nel contesto della conversazione corrente. Alcuni canali consentono l'avvio di nuove conversazioni con l'utente. Per avviare una nuova conversazione proattiva con l'utente, è sufficiente eliminare il campo conversazione dall'oggetto indirizzo prima di comporre il messaggio in uscita.

Extends

IEvent

Proprietà

address	Indirizzare le informazioni di routing per l'evento. Salvare questo campo in una risorsa di archiviazione esterna in un secondo momento per comporre un messaggio proattivo all'utente.
agent	SDK che elabora l'evento. Sarà sempre "botbuilder".
attachmentLayout	Suggerimento per il layout di più allegati da parte dei client. Il valore predefinito è 'list'.
attachments	Per i messaggi in arrivo contiene allegati come immagini inviate dall'utente. Per i messaggi in uscita contiene oggetti come schede o immagini da inviare all'utente.
code	Codice che indica il motivo per cui la conversazione è terminata.
deliveryMode	Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. La modalità di recapito predefinita è "default".
entities	Oggetti strutturati passati al bot o all'utente.
expriation	Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.
importance	Importanza dell'attività.
inputHint	Suggerimento per i client che informano se il bot prevede o meno un ulteriore input. I prompt predefiniti popolano automaticamente questo valore per i messaggi in uscita.
label	Etichetta descrittiva per l'attività.
listenFor	Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto.
localTimestamp	Ora locale in cui è stato inviato il messaggio (impostato dal client o dal bot, ad esempio: 2016-09-23T13:07:49.4714686-07:00.
localTimezone	Contiene il nome del fuso orario in cui il messaggio, nell'ora locale, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.
name	Nome dell'operazione da richiamare o il nome dell'evento.
relatesTo	Riferimento a un'altra conversazione o messaggio.
replyToId	L'ID dell'evento a cui l'aggiornamento è correlato.
semanticAction	Azione a livello di codice facoltativa associata a questa richiesta.
source	Origine originale dell'evento (ad esempio "facebook", "skype", "slack" e così via)
sourceEvent	Evento originale nello schema nativo delle origini. Per i messaggi in uscita è possibile usare per passare dati di evento specifici dell'origine, ad esempio allegati personalizzati.
speak	Messaggio parlato come Speech Synthesis Markup Language.
summary	Testo da visualizzare come fallback e come breve descrizione del contenuto del messaggio, ad esempio un elenco di conversazioni recenti.
text	Testo del messaggio.
textFormat	Formato dei campi di testo. Il valore predefinito è 'markdown'.
textHighlights	Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore ReplyToId.
textLocale	Lingua identificata del testo del messaggio, se noto.
timestamp	Ora UTC in cui è stato inviato il messaggio (impostato dal servizio).
type	Definisce il tipo di evento. Deve essere "message" per un IMessage.
user	Per i messaggi in arrivo si tratta dell'utente che ha inviato il messaggio. Per impostazione predefinita si tratta di una copia di address.user, ma è possibile configurare il bot con una funzione lookupUser che consente di eseguire il mapping dell'utente in ingresso a un ID utente interno.
value	Valore aperto.
valueType	Tipo dell'oggetto valore dell'attività.

Dettagli proprietà

address

Indirizzare le informazioni di routing per l'evento. Salvare questo campo in una risorsa di archiviazione esterna in un secondo momento per comporre un messaggio proattivo all'utente.

address: IAddress

Valore della proprietà

IAddress

agent

SDK che elabora l'evento. Sarà sempre "botbuilder".

agent: string

Valore della proprietà

string

attachmentLayout

Suggerimento per il layout di più allegati da parte dei client. Il valore predefinito è 'list'.

attachmentLayout?: string

Valore della proprietà

string

attachments

Per i messaggi in arrivo contiene allegati come immagini inviate dall'utente. Per i messaggi in uscita contiene oggetti come schede o immagini da inviare all'utente.

attachments?: IAttachment[]

Valore della proprietà

IAttachment[]

code

Codice che indica il motivo per cui la conversazione è terminata.

code?: string

Valore della proprietà

string

deliveryMode

Suggerimento di recapito per segnalare al destinatario percorsi di recapito alternativi per l'attività. La modalità di recapito predefinita è "default".

deliveryMode?: string

Valore della proprietà

string

entities

Oggetti strutturati passati al bot o all'utente.

entities?: any[]

Valore della proprietà

any[]

expriation

Il momento in cui l'attività deve essere considerata "scaduta" e non deve essere presentata al destinatario.

expriation?: string

Valore della proprietà

string

importance

Importanza dell'attività.

importance?: string

Valore della proprietà

string

inputHint

Suggerimento per i client che informano se il bot prevede o meno un ulteriore input. I prompt predefiniti popolano automaticamente questo valore per i messaggi in uscita.

inputHint?: string

Valore della proprietà

string

label

Etichetta descrittiva per l'attività.

label?: string

Valore della proprietà

string

listenFor

Elenco di frasi e riferimenti per i quali i sistemi di priming del parlato e della lingua devono essere in ascolto.

listenFor?: string[]

Valore della proprietà

string[]

localTimestamp

Ora locale in cui è stato inviato il messaggio (impostato dal client o dal bot, ad esempio: 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: string

Valore della proprietà

string

localTimezone

Contiene il nome del fuso orario in cui il messaggio, nell'ora locale, espresso in formato di database del fuso orario IANA. Ad esempio, America/Los_Angeles.

localTimezone?: string

Valore della proprietà

string

name

Nome dell'operazione da richiamare o il nome dell'evento.

name?: string

Valore della proprietà

string

relatesTo

Riferimento a un'altra conversazione o messaggio.

relatesTo?: IAddress

Valore della proprietà

IAddress

replyToId

L'ID dell'evento a cui l'aggiornamento è correlato.

replyToId?: string

Valore della proprietà

string

semanticAction

Azione a livello di codice facoltativa associata a questa richiesta.

semanticAction?: ISemanticAction

Valore della proprietà

ISemanticAction

source

Origine originale dell'evento (ad esempio "facebook", "skype", "slack" e così via)

source: string

Valore della proprietà

string

sourceEvent

Evento originale nello schema nativo delle origini. Per i messaggi in uscita è possibile usare per passare dati di evento specifici dell'origine, ad esempio allegati personalizzati.

sourceEvent: any

Valore della proprietà

any

speak

Messaggio parlato come Speech Synthesis Markup Language.

speak?: string

Valore della proprietà

string

summary

Testo da visualizzare come fallback e come breve descrizione del contenuto del messaggio, ad esempio un elenco di conversazioni recenti.

summary?: string

Valore della proprietà

string

text

Testo del messaggio.

text?: string

Valore della proprietà

string

textFormat

Formato dei campi di testo. Il valore predefinito è 'markdown'.

textFormat?: string

Valore della proprietà

string

textHighlights

Raccolta di frammenti di testo da evidenziare quando l'attività contiene un valore ReplyToId.

textHighlights?: ITextHighlight[]

Valore della proprietà

ITextHighlight[]

textLocale

Lingua identificata del testo del messaggio, se noto.

textLocale?: string

Valore della proprietà

string

timestamp

Ora UTC in cui è stato inviato il messaggio (impostato dal servizio).

timestamp?: string

Valore della proprietà

string

type

Definisce il tipo di evento. Deve essere "message" per un IMessage.

type: string

Valore della proprietà

string

user

Per i messaggi in arrivo si tratta dell'utente che ha inviato il messaggio. Per impostazione predefinita si tratta di una copia di address.user, ma è possibile configurare il bot con una funzione lookupUser che consente di eseguire il mapping dell'utente in ingresso a un ID utente interno.

user: IIdentity

Valore della proprietà

IIdentity

value

Valore aperto.

value?: any

Valore della proprietà

any

valueType

Tipo dell'oggetto valore dell'attività.

valueType?: string

Valore della proprietà

string