MessageFactory Kelas
Sekumpulan fungsi utilitas yang dirancang untuk membantu pemformatan berbagai jenis pesan yang dapat dikembalikan bot.
Konstruktor
MessageFactory()
Metode
| attachment |
Mengembalikan aktivitas pesan tunggal yang berisi lampiran. message = MessageFactory.attachment(CardFactory.hero_card(HeroCard(title='White T-Shirt', images=[CardImage(url= 'https://example.com/whiteShirt.jpg' )], buttons=[CardAction(title='buy')]))) menunggu context.send_activity(pesan) |
| carousel |
Mengembalikan pesan yang akan menampilkan sekumpulan lampiran menggunakan tata letak carousel. message = MessageFactory.carousel([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])), CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')]))), CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')]))]) menunggu context.send_activity(pesan) |
| content_url |
Mengembalikan pesan yang akan menampilkan satu gambar atau video kepada pengguna. message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'Foto dari liburan keluarga kami.') menunggu context.send_activity(pesan) |
| list |
Mengembalikan pesan yang akan menampilkan sekumpulan lampiran dalam formulir daftar. message = MessageFactory.list([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')]))), CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')]))), CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')]))]) menunggu context.send_activity(pesan) |
| suggested_actions |
Mengembalikan pesan yang menyertakan sekumpulan tindakan yang disarankan dan teks opsional. message = MessageFactory.suggested_actions([CardAction(title='a', type=ActionTypes.im_back, value='a'), CardAction(title='b', type=ActionTypes.im_back, value='b'), CardAction(title='c', type=ActionTypes.im_back, value='c')], 'Pilih warna') menunggu context.send_activity(pesan) |
| text |
Mengembalikan pesan teks sederhana. message = MessageFactory.text('Greetings from example message') tunggu context.send_activity(message) |
attachment
Mengembalikan aktivitas pesan tunggal yang berisi lampiran.
message = MessageFactory.attachment(CardFactory.hero_card(HeroCard(title='White T-Shirt', images=[CardImage(url= 'https://example.com/whiteShirt.jpg' )],
buttons=[CardAction(title='buy')])))
menunggu context.send_activity(pesan)
static attachment(attachment: Attachment, text: str = None, speak: str = None, input_hint: InputHints | str = None)
Parameter
| Nama | Deskripsi |
|---|---|
|
attachment
Diperlukan
|
|
|
text
|
Nilai default: None
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: None
|
carousel
Mengembalikan pesan yang akan menampilkan sekumpulan lampiran menggunakan tata letak carousel.
message = MessageFactory.carousel([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')])),
CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')]))),
CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')]))])
menunggu context.send_activity(pesan)
static carousel(attachments: List[Attachment], text: str = None, speak: str = None, input_hint: InputHints | str = None) -> Activity
Parameter
| Nama | Deskripsi |
|---|---|
|
attachments
Diperlukan
|
|
|
text
|
Nilai default: None
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: None
|
content_url
Mengembalikan pesan yang akan menampilkan satu gambar atau video kepada pengguna.
message = MessageFactory.content_url('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'Foto dari liburan keluarga kami.')
menunggu context.send_activity(pesan)
static content_url(url: str, content_type: str, name: str = None, text: str = None, speak: str = None, input_hint: InputHints | str = None)
Parameter
| Nama | Deskripsi |
|---|---|
|
url
Diperlukan
|
|
|
content_type
Diperlukan
|
|
|
name
|
Nilai default: None
|
|
text
|
Nilai default: None
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: None
|
list
Mengembalikan pesan yang akan menampilkan sekumpulan lampiran dalam formulir daftar.
message = MessageFactory.list([CardFactory.hero_card(HeroCard(title='title1', images=[CardImage(url='imageUrl1')], buttons=[CardAction(title='button1')]))),
CardFactory.hero_card(HeroCard(title='title2', images=[CardImage(url='imageUrl2')], buttons=[CardAction(title='button2')]))),
CardFactory.hero_card(HeroCard(title='title3', images=[CardImage(url='imageUrl3')], buttons=[CardAction(title='button3')]))])
menunggu context.send_activity(pesan)
static list(attachments: List[Attachment], text: str = None, speak: str = None, input_hint: InputHints | str = None) -> Activity
Parameter
| Nama | Deskripsi |
|---|---|
|
attachments
Diperlukan
|
|
|
text
|
Nilai default: None
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: None
|
suggested_actions
Mengembalikan pesan yang menyertakan sekumpulan tindakan yang disarankan dan teks opsional.
message = MessageFactory.suggested_actions([CardAction(title='a', type=ActionTypes.im_back, value='a'), CardAction(title='b', type=ActionTypes.im_back, value='b'), CardAction(title='c', type=ActionTypes.im_back, value='c')], 'Pilih warna')
menunggu context.send_activity(pesan)
static suggested_actions(actions: List[CardAction], text: str = None, speak: str = None, input_hint: InputHints | str = InputHints.accepting_input) -> Activity
Parameter
| Nama | Deskripsi |
|---|---|
|
actions
Diperlukan
|
|
|
text
|
Nilai default: None
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: InputHints.accepting_input
|
text
Mengembalikan pesan teks sederhana.
message = MessageFactory.text('Greetings from example message') tunggu context.send_activity(message)
static text(text: str, speak: str = None, input_hint: InputHints | str = InputHints.accepting_input) -> Activity
Parameter
| Nama | Deskripsi |
|---|---|
|
text
Diperlukan
|
|
|
speak
|
Nilai default: None
|
|
input_hint
|
Nilai default: InputHints.accepting_input
|