Bagikan melalui

IMessage interface

  • Referensi
Paket:
botbuilder

Pesan obrolan yang dikirim antara Pengguna dan Bot. Pesan dari bot kepada pengguna datang dalam dua rasa:

  • pesan reaktif adalah pesan yang dikirim dari Bot ke Pengguna sebagai balasan pesan masuk dari pengguna.
  • pesan proaktif adalah pesan yang dikirim dari Bot kepada Pengguna sebagai respons terhadap beberapa peristiwa eksternal seperti pemicu alarm.

Dalam kasus reaktif, Anda harus menyalin bidang alamat dari pesan masuk ke pesan keluar (jika Anda menggunakan kelas penyusun Pesan dan menginisialisasinya dengan sesi ini akan terjadi secara otomatis) dan kemudian mengatur teks atau lampiran . Untuk pesan proaktif, Anda harus menyimpan alamat dari pesan masuk ke penyimpanan eksternal di suatu tempat. Anda kemudian dapat meneruskannya ke UniversalBot.beginDialog() atau menyalinnya ke pesan keluar yang diteruskan ke UniversalBot.send().

Membuat pesan kepada pengguna menggunakan objek alamat masuk secara default akan mengirim balasan kepada pengguna dalam konteks percakapan saat ini. Beberapa saluran memungkinkan dimulainya percakapan baru dengan pengguna. Untuk memulai percakapan proaktif baru dengan pengguna cukup hapus bidang percakapan dari objek alamat sebelum membuat pesan keluar.

Memperluas
IEvent

Properti

address

Informasi perutean alamat untuk peristiwa tersebut. Simpan bidang ini ke penyimpanan eksternal di suatu tempat untuk nanti menyusun pesan proaktif kepada pengguna.
agent

SDK yang memproses peristiwa. Akan selalu 'botbuilder'.
attachmentLayout

Petunjuk tentang bagaimana klien harus membuat tata letak beberapa lampiran. Nilai defaultnya adalah 'list'.
attachments

Untuk pesan masuk berisi lampiran seperti gambar yang dikirim dari pengguna. Untuk pesan keluar berisi objek seperti kartu atau gambar untuk dikirim ke pengguna.
code

Kode yang menunjukkan mengapa percakapan telah berakhir.
deliveryMode

Petunjuk pengiriman untuk memberi sinyal ke jalur pengiriman alternatif penerima untuk aktivitas tersebut. Mode pengiriman default adalah "default".
entities

Objek terstruktur diteruskan ke bot atau pengguna.
expriation

Waktu di mana aktivitas harus dianggap "kedaluwarsa" dan tidak boleh disajikan kepada penerima.
importance

Pentingnya aktivitas.
inputHint

Petunjuk untuk klien yang memberi tahu mereka apakah bot mengharapkan input lebih lanjut atau tidak. Perintah bawaan akan secara otomatis mengisi nilai ini untuk pesan keluar.
label

Label deskriptif untuk aktivitas.
listenFor

Daftar frasa dan referensi yang harus didengarkan oleh sistem pendeta ucapan dan bahasa.
localTimestamp

Waktu lokal ketika pesan dikirim (diatur oleh klien atau bot, Misalnya: 2016-09-23T13:07:49.4714686-07:00.)
localTimezone

Berisi nama zona waktu di mana pesan, dalam waktu lokal, yang dinyatakan dalam format database Zona Waktu IANA. Misalnya, Amerika/Los_Angeles.
name

Nama operasi yang akan dipanggil atau nama peristiwa.
relatesTo

Referensi ke percakapan atau pesan lain.
replyToId

ID peristiwa yang terkait dengan pembaruan ini.
semanticAction

Tindakan terprogram opsional yang menyertai permintaan ini.
source

Sumber asli acara (yaitu 'facebook', 'skype', 'slack', dll.)
sourceEvent

Peristiwa asli dalam skema asli sumber. Untuk pesan keluar dapat digunakan untuk meneruskan data peristiwa tertentu sumber seperti lampiran kustom.
speak

Pesan lisan sebagai Speech Synthesis Markup Language.
summary

Teks yang akan ditampilkan sebagai fall-back dan deskripsi singkat konten pesan misalnya daftar percakapan terbaru.
text

Teks pesan.
textFormat

Format bidang teks. Nilai defaultnya adalah 'markdown'.
textHighlights

Kumpulan fragmen teks yang akan disorot saat aktivitas berisi nilai ReplyToId.
textLocale

Bahasa yang diidentifikasi dari teks pesan jika diketahui.
timestamp

Waktu UTC saat pesan dikirim (diatur menurut layanan.)
type

Menentukan jenis peristiwa. Harus berupa 'pesan' untuk IMessage.
user

Untuk pesan masuk, ini adalah pengguna yang mengirim pesan. Secara default ini adalah salinan address.user tetapi Anda dapat mengonfigurasi bot Anda dengan fungsi lookupUser yang memungkinkan memetakan pengguna masuk ke id pengguna internal.
value

Nilai terbuka.
valueType

Jenis objek nilai aktivitas.

Detail Properti

address

Informasi perutean alamat untuk peristiwa tersebut. Simpan bidang ini ke penyimpanan eksternal di suatu tempat untuk nanti menyusun pesan proaktif kepada pengguna.

address: IAddress

Nilai Properti

IAddress

agent

SDK yang memproses peristiwa. Akan selalu 'botbuilder'.

agent: string

Nilai Properti

string

attachmentLayout

Petunjuk tentang bagaimana klien harus membuat tata letak beberapa lampiran. Nilai defaultnya adalah 'list'.

attachmentLayout?: string

Nilai Properti

string

attachments

Untuk pesan masuk berisi lampiran seperti gambar yang dikirim dari pengguna. Untuk pesan keluar berisi objek seperti kartu atau gambar untuk dikirim ke pengguna.

attachments?: IAttachment[]

Nilai Properti

IAttachment[]

code

Kode yang menunjukkan mengapa percakapan telah berakhir.

code?: string

Nilai Properti

string

deliveryMode

Petunjuk pengiriman untuk memberi sinyal ke jalur pengiriman alternatif penerima untuk aktivitas tersebut. Mode pengiriman default adalah "default".

deliveryMode?: string

Nilai Properti

string

entities

Objek terstruktur diteruskan ke bot atau pengguna.

entities?: any[]

Nilai Properti

any[]

expriation

Waktu di mana aktivitas harus dianggap "kedaluwarsa" dan tidak boleh disajikan kepada penerima.

expriation?: string

Nilai Properti

string

importance

Pentingnya aktivitas.

importance?: string

Nilai Properti

string

inputHint

Petunjuk untuk klien yang memberi tahu mereka apakah bot mengharapkan input lebih lanjut atau tidak. Perintah bawaan akan secara otomatis mengisi nilai ini untuk pesan keluar.

inputHint?: string

Nilai Properti

string

label

Label deskriptif untuk aktivitas.

label?: string

Nilai Properti

string

listenFor

Daftar frasa dan referensi yang harus didengarkan oleh sistem pendeta ucapan dan bahasa.

listenFor?: string[]

Nilai Properti

string[]

localTimestamp

Waktu lokal ketika pesan dikirim (diatur oleh klien atau bot, Misalnya: 2016-09-23T13:07:49.4714686-07:00.)

localTimestamp?: string

Nilai Properti

string

localTimezone

Berisi nama zona waktu di mana pesan, dalam waktu lokal, yang dinyatakan dalam format database Zona Waktu IANA. Misalnya, Amerika/Los_Angeles.

localTimezone?: string

Nilai Properti

string

name

Nama operasi yang akan dipanggil atau nama peristiwa.

name?: string

Nilai Properti

string

relatesTo

Referensi ke percakapan atau pesan lain.

relatesTo?: IAddress

Nilai Properti

IAddress

replyToId

ID peristiwa yang terkait dengan pembaruan ini.

replyToId?: string

Nilai Properti

string

semanticAction

Tindakan terprogram opsional yang menyertai permintaan ini.

semanticAction?: ISemanticAction

Nilai Properti

ISemanticAction

source

Sumber asli acara (yaitu 'facebook', 'skype', 'slack', dll.)

source: string

Nilai Properti

string

sourceEvent

Peristiwa asli dalam skema asli sumber. Untuk pesan keluar dapat digunakan untuk meneruskan data peristiwa tertentu sumber seperti lampiran kustom.

sourceEvent: any

Nilai Properti

any

speak

Pesan lisan sebagai Speech Synthesis Markup Language.

speak?: string

Nilai Properti

string

summary

Teks yang akan ditampilkan sebagai fall-back dan deskripsi singkat konten pesan misalnya daftar percakapan terbaru.

summary?: string

Nilai Properti

string

text

Teks pesan.

text?: string

Nilai Properti

string

textFormat

Format bidang teks. Nilai defaultnya adalah 'markdown'.

textFormat?: string

Nilai Properti

string

textHighlights

Kumpulan fragmen teks yang akan disorot saat aktivitas berisi nilai ReplyToId.

textHighlights?: ITextHighlight[]

Nilai Properti

ITextHighlight[]

textLocale

Bahasa yang diidentifikasi dari teks pesan jika diketahui.

textLocale?: string

Nilai Properti

string

timestamp

Waktu UTC saat pesan dikirim (diatur menurut layanan.)

timestamp?: string

Nilai Properti

string

type

Menentukan jenis peristiwa. Harus berupa 'pesan' untuk IMessage.

type: string

Nilai Properti

string

user

Untuk pesan masuk, ini adalah pengguna yang mengirim pesan. Secara default ini adalah salinan address.user tetapi Anda dapat mengonfigurasi bot Anda dengan fungsi lookupUser yang memungkinkan memetakan pengguna masuk ke id pengguna internal.

user: IIdentity

Nilai Properti

IIdentity

value

Nilai terbuka.

value?: any

Nilai Properti

any

valueType

Jenis objek nilai aktivitas.

valueType?: string

Nilai Properti

string