MessageFactory class

Referensi

Paket:: botbuilder-core

Sekumpulan fungsi utilitas untuk membantu pemformatan berbagai jenis pesan yang dapat dikembalikan bot.

Keterangan

Contoh berikut menunjukkan pengiriman pesan yang berisi satu kartu 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);

Metode

attachment(Attachment, string, string, InputHints \| string)	Mengembalikan aktivitas pesan tunggal yang berisi lampiran.
carousel(Attachment[], string, string, InputHints \| string)	Mengembalikan pesan yang akan menampilkan sekumpulan lampiran menggunakan tata letak carousel.
contentUrl(string, string, string, string, string, InputHints \| string)	Mengembalikan pesan yang akan menampilkan satu gambar atau video kepada pengguna.
list(Attachment[], string, string, InputHints \| string)	Mengembalikan pesan yang akan menampilkan sekumpulan lampiran dalam formulir daftar.
suggestedActions(string \| CardAction[], string, string, InputHints \| string)	Mengembalikan pesan yang menyertakan sekumpulan tindakan yang disarankan dan teks opsional.
text(string, string, InputHints \| string)	Mengembalikan pesan teks sederhana.

Detail Metode

attachment(Attachment, string, string, InputHints | string)

Mengembalikan aktivitas pesan tunggal yang berisi lampiran.

static function attachment(attachment: Attachment, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

attachment: Attachment

Kartu adaptif untuk disertakan dalam pesan.

text: string

(Opsional) teks pesan.

speak: string

(Opsional) SSML untuk disertakan dengan pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan. Default ke acceptingInput.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang berisi lampiran.

Keterangan

Contoh ini menunjukkan pembuatan pesan dengan lampiran kartu pahlawan:

const message = MessageFactory.attachment(
    CardFactory.heroCard(
        'White T-Shirt',
        ['https://example.com/whiteShirt.jpg'],
        ['buy']
     )
);

carousel(Attachment[], string, string, InputHints | string)

Mengembalikan pesan yang akan menampilkan sekumpulan lampiran menggunakan tata letak carousel.

static function carousel(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

attachments: Attachment[]

Array lampiran untuk disertakan dalam pesan.

text: string

(Opsional) teks pesan.

speak: string

(Opsional) SSML untuk disertakan dengan pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang akan menampilkan sekumpulan lampiran menggunakan tata letak carousel.

Keterangan

Contoh ini menunjukkan pembuatan pesan dengan carousel kartu 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)

Mengembalikan pesan yang akan menampilkan satu gambar atau video kepada pengguna.

static function contentUrl(url: string, contentType: string, name?: string, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

url: string

Url gambar/video yang akan dikirim.

contentType: string

Jenis MIME gambar/video.

name: string

(Opsional) Nama file gambar/video.

text: string

(Opsional) teks pesan.

speak: string

(Opsional) SSML untuk disertakan dengan pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang akan menampilkan satu gambar atau video kepada pengguna.

Keterangan

Contoh ini menunjukkan pengiriman gambar kepada pengguna:

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)

Mengembalikan pesan yang akan menampilkan sekumpulan lampiran dalam formulir daftar.

static function list(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

attachments: Attachment[]

Array lampiran untuk disertakan dalam pesan.

text: string

(Opsional) teks pesan.

speak: string

(Opsional) SSML untuk disertakan dengan pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang akan menampilkan sekumpulan lampiran dalam formulir daftar.

Keterangan

Contoh ini menunjukkan pembuatan pesan dengan daftar kartu pahlawan:

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)

Mengembalikan pesan yang menyertakan sekumpulan tindakan yang disarankan dan teks opsional.

static function suggestedActions(actions: string | CardAction[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

actions: string | CardAction[]

Array tindakan kartu atau string untuk disertakan. String akan dikonversi ke tindakan messageBack.

text: string

(Opsional) teks pesan.

speak: string

(Opsional) SSML untuk disertakan dengan pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan. Default ke acceptingInput.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang berisi tindakan yang disarankan.

Keterangan

Contoh ini memperlihatkan pembuatan pesan dengan tindakan yang disarankan:

const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], `Choose a color`);

text(string, string, InputHints | string)

Mengembalikan pesan teks sederhana.

static function text(text: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>

Parameter

text: string

Teks yang akan disertakan dalam pesan.

speak: string

(Opsional) SSML untuk disertakan dalam pesan.

inputHint: InputHints | string

(Opsional) petunjuk input untuk pesan. Default ke acceptingInput.

Mengembalikan

Partial<Activity>

Aktivitas pesan yang berisi teks.

Keterangan

Contoh ini menunjukkan pengiriman pesan teks sederhana:

const message = MessageFactory.text('Greetings from example message');