MessageFactory Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.builder
Artefatto Maven:
com.microsoft.bot:bot-builder:4.14.3
  • java.lang.Object
    • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

Contiene metodi di utilità per vari tipi di messaggio che un bot può restituire.

Creare e inviare un messaggio. Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

Il codice seguente si applica alle azioni del messaggio in generale. Vedere la documentazione del canale per i limiti imposti al contenuto del testo del messaggio da inviare.

Per controllare varie caratteristiche del parlato del bot, ad esempio voce, frequenza, volume, pronuncia e passo, specificare il test per parlare in formato SSML (Speech Synthesis Markup Language).

I canali decidono il modo in cui ogni azione della scheda si manifesta nell'esperienza utente. Nella maggior parte dei casi, le schede sono selezionabili. In altri, possono essere selezionati dall'input vocale. Nei casi in cui il canale non offre un'esperienza di attivazione interattiva (ad esempio, durante l'interazione tramite SMS), il canale potrebbe non supportare l'attivazione. La decisione su come eseguire il rendering delle azioni è controllata da requisiti normativi altrove in questo documento (ad esempio, all'interno del formato della scheda o all'interno della definizione delle azioni suggerite).

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
static Activity attachment(Attachment attachment)

Restituisce un'attività di messaggio che contiene un allegato.
static Activity attachment(Attachment attachment, String text)

Restituisce un'attività di messaggio che contiene un allegato.
static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene un allegato.
static Activity attachment(List<Attachment> attachments)

Restituisce un'attività di messaggio che contiene un allegato.
static Activity attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene un allegato.
static Activity carousel(List<Attachment> attachments, String text)

Restituisce un'attività di messaggio che contiene una raccolta di allegati, in un elenco.
static Activity carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene una raccolta di allegati, in un elenco.
static Activity contentUrl(String url, String contentType)

Restituisce un'attività di messaggio che contiene una singola immagine o video.
static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene una singola immagine o video.
static Activity suggestedActions(List<String> actions, String text)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.
static Activity suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.
static Activity suggestedCardActions(List<CardAction> actions, String text)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.
static Activity suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.
static Activity text(String text)

Restituisce un semplice messaggio di testo.
static Activity text(String text, String ssml, InputHints inputHint)

Restituisce un semplice messaggio di testo.

Metodi ereditati da java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Dettagli metodo

attachment

public static Activity attachment(Attachment attachment)

Restituisce un'attività di messaggio che contiene un allegato.

Parametri:

attachment - Allegato da includere nel messaggio.

Restituisce:

Attività di messaggio contenente l'allegato.

attachment

public static Activity attachment(Attachment attachment, String text)

Restituisce un'attività di messaggio che contiene un allegato.

Parametri:

attachment - Allegato da includere nel messaggio.
text - Facoltativo, il testo del messaggio da inviare.

Restituisce:

Attività di messaggio contenente l'allegato.

attachment

public static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene un allegato.

Parametri:

attachment - Allegato da includere nel messaggio.
text - Facoltativo, il testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente l'allegato.

attachment

public static Activity attachment(List attachments)

Restituisce un'attività di messaggio che contiene un allegato.

Parametri:

attachments - Allegati da includere nel messaggio.

Restituisce:

Attività di messaggio contenente l'allegato.

attachment

public static Activity attachment(List attachments, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene un allegato.

Parametri:

attachments - Allegati da includere nel messaggio.
text - Facoltativo, il testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente l'allegato.

carousel

public static Activity carousel(List attachments, String text)

Restituisce un'attività di messaggio che contiene una raccolta di allegati, in un elenco.

Parametri:

attachments - Allegati da includere nel messaggio.
text - Facoltativo, il testo del messaggio da inviare.

Restituisce:

Attività di messaggio contenente l'allegato.

carousel

public static Activity carousel(List attachments, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene una raccolta di allegati, in un elenco.

Parametri:

attachments - Allegati da includere nel messaggio.
text - Facoltativo, il testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente l'allegato.

contentUrl

public static Activity contentUrl(String url, String contentType)

Restituisce un'attività di messaggio che contiene una singola immagine o video.

Parametri:

url - URL dell'immagine o del video da inviare.
contentType - Tipo MIME dell'immagine o del video.

Restituisce:

Attività di messaggio contenente l'allegato.

contentUrl

public static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

Restituisce un'attività di messaggio che contiene una singola immagine o video.

Parametri:

url - URL dell'immagine o del video da inviare.
contentType - Tipo MIME dell'immagine o del video.
name - Facoltativo, nome dell'immagine o del file video.
text - Facoltativo, il testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente l'allegato.

suggestedActions

public static Activity suggestedActions(List actions, String text)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo. // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parametri:

actions - Testo delle azioni da creare.
text - Opzionale. Testo del messaggio da inviare.

Restituisce:

Attività di messaggio contenente le azioni suggerite.

suggestedActions

public static Activity suggestedActions(List actions, String text, String ssml, InputHints inputHint)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo. // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parametri:

actions - Testo delle azioni da creare.
text - Opzionale. Testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente le azioni suggerite.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.

Parametri:

actions - Azioni della scheda da includere.
text - Facoltativo, il testo del messaggio da inviare.

Restituisce:

Attività di messaggio che contiene le azioni suggerite.

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text, String ssml, InputHints inputHint)

Restituisce un messaggio che include un set di azioni suggerite e testo facoltativo.

Parametri:

actions - Azioni della scheda da includere.
text - Facoltativo, il testo del messaggio da inviare.
ssml - Facoltativo, il testo da pronunciare dal bot in un canale di abilitazione vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio che contiene le azioni suggerite.

text

public static Activity text(String text)

Restituisce un semplice messaggio di testo.

Parametri:

text - Testo del messaggio da inviare.

Restituisce:

Attività di messaggio contenente il testo.

text

public static Activity text(String text, String ssml, InputHints inputHint)

Restituisce un semplice messaggio di testo.

Parametri:

text - Testo del messaggio da inviare.
ssml - Facoltativo, testo da pronunciare dal bot in un canale abilitato per il riconoscimento vocale.
inputHint - Facoltativo, indica se il bot accetta, prevede o ignora l'input dell'utente dopo che il messaggio viene recapitato al client. Il valore predefinito è ACCEPTING_INPUT.

Restituisce:

Attività di messaggio contenente il testo.

Si applica a