Message class

Pacchetto:

botbuilder

Classe message builder che semplifica la creazione di messaggi complessi con allegati.

Costruttori

Message(Session)

Crea un nuovo generatore di messaggi.

Metodi

addAttachment(AttachmentType)	Aggiunge un allegato al messaggio. Per esempi, vedere IAttachment.
addEntity(Object)	Aggiunge un'entità al messaggio.
address(IAddress)	Informazioni di routing degli indirizzi per il messaggio. Salvare questo campo in una risorsa di archiviazione esterna in un secondo momento per comporre un messaggio proattivo all'utente.
attachmentLayout(string)	Suggerimento per il layout di più allegati da parte dei client. Il valore predefinito è 'list'.
attachments(AttachmentType[])	Schede o immagini da inviare all'utente.
code(string)	Codice che indica il motivo per cui la conversazione è terminata.
compose(string[][], any[])	Compone una risposta complessa e casuale all'utente.
composePrompt(Session, string[][], any[])	deprecato usare compose().
composePrompt(Session, string[][], any[])	Combina una matrice di richieste in un'unica richiesta localizzata e quindi, facoltativamente, riempie gli slot modello dei prompt con gli argomenti passati.
entities(Object[])	Oggetti strutturati passati al bot o all'utente.
inputHint(string)	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.
localTimestamp(string)	Ora locale in cui è stato inviato il messaggio (impostato dal client o dal bot, ad esempio: 2016-09-23T13:07:49.4714686-07:00.
name(string)	Nome dell'operazione da richiamare o il nome dell'evento.
nspeak(TextType, TextType, number)	Impostare in modo condizionale il campo speak del messaggio in base a un conteggio specificato.
ntext(TextType, TextType, number)	Impostare in modo condizionale il testo del messaggio in base a un conteggio specificato.
originalEvent(any)	Messaggio in formato originale/nativo del canale per i messaggi in arrivo.
randomPrompt(TextType)	Seleziona un prompt in modo casuale.
relatesTo(IAddress)	Riferimento a un'altra conversazione o messaggio.
setChannelData(any)	deprecato usare sourceEvent().
setLanguage(string)	deprecato usare local().
setNText(Session, string, string, number)	DEPRECATO usare ntext().
setText(Session, TextType, any[])	DEPRECATO usare text().
sourceEvent(ISourceEventMap)	Per i messaggi in uscita è possibile usare per passare dati di evento specifici dell'origine, ad esempio allegati personalizzati.
speak(TextType, any[])	Imposta il campo speak del messaggio come Speech Synthesis Markup Language (SSML). Verrà parlato con l'utente nei dispositivi supportati.
suggestedActions(ISuggestedActions | IIsSuggestedActions)	Azioni suggerite facoltative da inviare all'utente. Le azioni suggerite verranno visualizzate solo nei canali che supportano le azioni suggerite.
summary(TextType, any[])	Testo da visualizzare come fallback e come breve descrizione del contenuto del messaggio, ad esempio un elenco di conversazioni recenti.
text(TextType, any[])	Imposta il testo del messaggio.
textFormat(string)	Formato dei campi di testo.
textLocale(string)	Lingua del messaggio.
timestamp(string)	Impostato dal servizio connettori. Usare localTimestamp().
toMessage()	Restituisce il codice JSON per il messaggio.
value(any)	Valore aperto.

Dettagli costruttore

Message(Session)

Crea un nuovo generatore di messaggi.

new Message(session?: Session)

Parametri

session

Session

(Facoltativo) verrà usato per popolare l'indirizzo dei messaggi e localizzare qualsiasi testo.

Dettagli metodo

addAttachment(AttachmentType)

Aggiunge un allegato al messaggio. Per esempi, vedere IAttachment.

function addAttachment(attachment: AttachmentType)

Parametri

attachment

AttachmentType

Allegato da aggiungere.

Restituisce

Message

addEntity(Object)

Aggiunge un'entità al messaggio.

function addEntity(obj: Object)

Parametri

obj

Object

Restituisce

Message

address(IAddress)

Informazioni di routing degli indirizzi per il messaggio. Salvare questo campo in una risorsa di archiviazione esterna in un secondo momento per comporre un messaggio proattivo all'utente.

function address(adr: IAddress)

Parametri

adr

IAddress

Restituisce

Message

attachmentLayout(string)

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

function attachmentLayout(style: string)

Parametri

style

string

Restituisce

Message

attachments(AttachmentType[])

Schede o immagini da inviare all'utente.

function attachments(list: AttachmentType[])

Parametri

list

AttachmentType[]

Restituisce

Message

code(string)

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

function code(value: string)

Parametri

value

string

Restituisce

Message

compose(string[][], any[])

Compone una risposta complessa e casuale all'utente.

function compose(prompts: string[][], args: any[])

Parametri

prompts

string[][]

args

any[]

Restituisce

Message

composePrompt(Session, string[][], any[])

deprecato usare compose().

function composePrompt(session: Session, prompts: string[][], args: any[])

Parametri

session

Session

prompts

string[][]

args

any[]

Restituisce

Message

composePrompt(Session, string[][], any[])

Combina una matrice di richieste in un'unica richiesta localizzata e quindi, facoltativamente, riempie gli slot modello dei prompt con gli argomenti passati.

static function composePrompt(session: Session, prompts: string[][], args?: any[])

Parametri

session

Session

Oggetto sessione utilizzato per localizzare le singole parti del prompt.

prompts

string[][]

Matrice di elenchi di richieste. Ogni voce nella matrice è un'altra matrice di richieste che verranno scelte in modo casuale. Il testo di output combinato sarà delimitato da spazi.

args

any[]

(Facoltativo) matrice di argomenti usati per formattare il testo di output quando il prompt è un modello.

Restituisce

string

entities(Object[])

Oggetti strutturati passati al bot o all'utente.

function entities(list: Object[])

Parametri

list

Object[]

Restituisce

Message

inputHint(string)

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.

function inputHint(hint: string)

Parametri

hint

string

Restituisce

Message

localTimestamp(string)

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

function localTimestamp(time?: string)

Parametri

time

string

(Facoltativo) tempo espresso come stringa ISO. Il valore predefinito è new Date().toISOString().

Restituisce

Message

name(string)

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

function name(name: string)

Parametri

name

string

Restituisce

Message

nspeak(TextType, TextType, number)

Impostare in modo condizionale il campo speak del messaggio in base a un conteggio specificato.

function nspeak(ssml: TextType, ssml_plural: TextType, count: number)

Parametri

ssml

TextType

ssml_plural

TextType

count

number

Restituisce

Message

ntext(TextType, TextType, number)

Impostare in modo condizionale il testo del messaggio in base a un conteggio specificato.

function ntext(msg: TextType, msg_plural: TextType, count: number)

Parametri

msg

TextType

msg_plural

TextType

count

number

Restituisce

Message

originalEvent(any)

Messaggio in formato originale/nativo del canale per i messaggi in arrivo.

function originalEvent(event: any)

Parametri

event

any

Restituisce

Message

randomPrompt(TextType)

Seleziona un prompt in modo casuale.

static function randomPrompt(prompts: TextType)

Parametri

prompts

TextType

Matrice di richieste tra cui scegliere. Quando le richieste sono di tipo stringa la richiesta verrà semplicemente restituita senza modifiche.

Restituisce

string

relatesTo(IAddress)

Riferimento a un'altra conversazione o messaggio.

function relatesTo(adr: IAddress)

Parametri

adr

IAddress

Restituisce

Message

setChannelData(any)

deprecato usare sourceEvent().

function setChannelData(data: any)

Parametri

data

any

Restituisce

Message

setLanguage(string)

deprecato usare local().

function setLanguage(language: string)

Parametri

language

string

Restituisce

Message

setNText(Session, string, string, number)

DEPRECATO usare ntext().

function setNText(session: Session, msg: string, msg_plural: string, count: number)

Parametri

session

Session

msg

string

msg_plural

string

count

number

Restituisce

Message

setText(Session, TextType, any[])

DEPRECATO usare text().

function setText(session: Session, prompt: TextType, args: any[])

Parametri

session

Session

prompt

TextType

args

any[]

Restituisce

Message

sourceEvent(ISourceEventMap)

Per i messaggi in uscita è possibile usare per passare dati di evento specifici dell'origine, ad esempio allegati personalizzati.

function sourceEvent(map: ISourceEventMap)

Parametri

map

ISourceEventMap

Restituisce

Message

speak(TextType, any[])

Imposta il campo speak del messaggio come Speech Synthesis Markup Language (SSML). Verrà parlato con l'utente nei dispositivi supportati.

function speak(ssml: TextType, args: any[])

Parametri

ssml

TextType

args

any[]

Restituisce

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

Azioni suggerite facoltative da inviare all'utente. Le azioni suggerite verranno visualizzate solo nei canali che supportano le azioni suggerite.

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

Parametri

suggestedActions

ISuggestedActions | IIsSuggestedActions

Restituisce

Message

summary(TextType, any[])

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

function summary(text: TextType, args: any[])

Parametri

text

TextType

args

any[]

Restituisce

Message

text(TextType, any[])

Imposta il testo del messaggio.

function text(text: TextType, args: any[])

Parametri

text

TextType

args

any[]

Restituisce

Message

textFormat(string)

Formato dei campi di testo.

function textFormat(style: string)

Parametri

style

string

Restituisce

Message

textLocale(string)

Lingua del messaggio.

function textLocale(locale: string)

Parametri

locale

string

Restituisce

Message

timestamp(string)

Impostato dal servizio connettori. Usare localTimestamp().

function timestamp(time?: string)

Parametri

time

string

Restituisce

Message

toMessage()

Restituisce il codice JSON per il messaggio.

function toMessage()

Restituisce

IMessage

value(any)

Valore aperto.

function value(param: any)

Parametri

param

any

Restituisce

Message