Bagikan melalui

Activity interface

  • Referensi
Paket:
botframework-schema

Aktivitas adalah jenis komunikasi dasar untuk protokol Bot Framework 3.0.

Properti

action

Menunjukkan apakah penerima contactRelationUpdate ditambahkan atau dihapus dari daftar kontak pengirim.
attachmentLayout

Petunjuk tata letak untuk beberapa lampiran. Default: daftar. Nilai yang mungkin termasuk: 'list', 'carousel'
attachments

Lampiran
callerId

String yang berisi URI yang mengidentifikasi pemanggil bot. Bidang ini tidak dimaksudkan untuk ditransmisikan melalui kawat, tetapi sebaliknya diisi oleh bot dan klien berdasarkan data yang dapat diverifikasi secara kriptografis yang menegaskan identitas pemanggil (misalnya token).
channelData

Berisi konten khusus saluran.
channelId

Berisi ID yang mengidentifikasi saluran secara unik. Diatur oleh saluran.
code

Kode untuk aktivitas endOfConversation yang menunjukkan mengapa percakapan berakhir. Nilai yang mungkin termasuk: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'
conversation

Mengidentifikasi percakapan tempat aktivitas berada.
deliveryMode

Petunjuk pengiriman untuk memberi sinyal ke jalur pengiriman alternatif penerima untuk aktivitas tersebut. Mode pengiriman default adalah "default". Nilai yang mungkin termasuk: 'normal', 'notification', 'expectReplies', 'ephemeral'
entities

Mewakili entitas yang disebutkan dalam pesan.
expiration

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

Mengidentifikasi pengirim pesan.
historyDisclosed

Menunjukkan apakah riwayat saluran sebelumnya diungkapkan.
id

Berisi ID yang secara unik mengidentifikasi aktivitas di saluran.
importance

Pentingnya aktivitas. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'
inputHint

Menunjukkan apakah bot Anda menerima, mengharapkan, atau mengabaikan input pengguna setelah pesan dikirimkan ke klien. Nilai yang mungkin termasuk: 'acceptingInput', 'ignoringInput', 'expectingInput'
label

Label deskriptif untuk aktivitas.
listenFor

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

Nama lokal untuk konten bidang teks. Nama lokal adalah kombinasi dari kode budaya iso 639 dua atau tiga huruf yang terkait dengan bahasa dan kode subkultur dua huruf ISO 3166 yang terkait dengan negara atau wilayah. Nama lokal juga dapat sesuai dengan tag bahasa BCP-47 yang valid.
localTimestamp

Berisi tanggal dan waktu pesan lokal, yang dinyatakan dalam format ISO-8601. Misalnya, 2016-09-23T13:07:49.4714686-07:00.
localTimezone

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

Kumpulan anggota ditambahkan ke percakapan.
membersRemoved

Kumpulan anggota dihapus dari percakapan.
name

Nama operasi yang terkait dengan aktivitas pemanggilan atau peristiwa.
reactionsAdded

Kumpulan reaksi ditambahkan ke percakapan.
reactionsRemoved

Kumpulan reaksi dihapus dari percakapan.
recipient

Mengidentifikasi penerima pesan.
relatesTo

Referensi ke percakapan atau aktivitas lain.
replyToId

Berisi ID pesan di mana pesan ini adalah balasan.
semanticAction

Tindakan terprogram opsional yang menyertai permintaan ini
serviceUrl

Berisi URL yang menentukan titik akhir layanan saluran. Diatur oleh saluran.
speak

Teks yang akan diucapkan.
suggestedActions

Tindakan yang disarankan untuk aktivitas tersebut.
summary

Teks yang akan ditampilkan jika saluran tidak dapat merender kartu.
text

Konten teks pesan.
textFormat

Format bidang teks Default:markdown. Nilai yang mungkin termasuk: 'markdown', 'plain', 'xml'
textHighlights

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

Berisi tanggal dan waktu pesan dikirim, dalam UTC, yang dinyatakan dalam format ISO-8601.
topicName

Nama topik percakapan yang diperbarui.
type

Berisi jenis aktivitas. Nilai yang mungkin termasuk: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'
value

Nilai yang terkait dengan aktivitas.
valueType

Jenis objek nilai aktivitas.

Detail Properti

action

Menunjukkan apakah penerima contactRelationUpdate ditambahkan atau dihapus dari daftar kontak pengirim.

action?: string

Nilai Properti

string

attachmentLayout

Petunjuk tata letak untuk beberapa lampiran. Default: daftar. Nilai yang mungkin termasuk: 'list', 'carousel'

attachmentLayout?: AttachmentLayoutTypes | string

Nilai Properti

AttachmentLayoutTypes | string

attachments

Lampiran

attachments?: Attachment[]

Nilai Properti

Attachment[]

callerId

String yang berisi URI yang mengidentifikasi pemanggil bot. Bidang ini tidak dimaksudkan untuk ditransmisikan melalui kawat, tetapi sebaliknya diisi oleh bot dan klien berdasarkan data yang dapat diverifikasi secara kriptografis yang menegaskan identitas pemanggil (misalnya token).

callerId: string

Nilai Properti

string

channelData

Berisi konten khusus saluran.

channelData?: any

Nilai Properti

any

channelId

Berisi ID yang mengidentifikasi saluran secara unik. Diatur oleh saluran.

channelId: string

Nilai Properti

string

code

Kode untuk aktivitas endOfConversation yang menunjukkan mengapa percakapan berakhir. Nilai yang mungkin termasuk: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

code?: EndOfConversationCodes | string

Nilai Properti

EndOfConversationCodes | string

conversation

Mengidentifikasi percakapan tempat aktivitas berada.

conversation: ConversationAccount

Nilai Properti

ConversationAccount

deliveryMode

Petunjuk pengiriman untuk memberi sinyal ke jalur pengiriman alternatif penerima untuk aktivitas tersebut. Mode pengiriman default adalah "default". Nilai yang mungkin termasuk: 'normal', 'notification', 'expectReplies', 'ephemeral'

deliveryMode?: DeliveryModes | string

Nilai Properti

DeliveryModes | string

entities

Mewakili entitas yang disebutkan dalam pesan.

entities?: Entity[]

Nilai Properti

Entity[]

expiration

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

expiration?: Date

Nilai Properti

Date

from

Mengidentifikasi pengirim pesan.

from: ChannelAccount

Nilai Properti

ChannelAccount

historyDisclosed

Menunjukkan apakah riwayat saluran sebelumnya diungkapkan.

historyDisclosed?: boolean

Nilai Properti

boolean

id

Berisi ID yang secara unik mengidentifikasi aktivitas di saluran.

id?: string

Nilai Properti

string

importance

Pentingnya aktivitas. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi'

importance?: ActivityImportance | string

Nilai Properti

ActivityImportance | string

inputHint

Menunjukkan apakah bot Anda menerima, mengharapkan, atau mengabaikan input pengguna setelah pesan dikirimkan ke klien. Nilai yang mungkin termasuk: 'acceptingInput', 'ignoringInput', 'expectingInput'

inputHint?: InputHints | string

Nilai Properti

InputHints | 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[]

locale

Nama lokal untuk konten bidang teks. Nama lokal adalah kombinasi dari kode budaya iso 639 dua atau tiga huruf yang terkait dengan bahasa dan kode subkultur dua huruf ISO 3166 yang terkait dengan negara atau wilayah. Nama lokal juga dapat sesuai dengan tag bahasa BCP-47 yang valid.

locale?: string

Nilai Properti

string

localTimestamp

Berisi tanggal dan waktu pesan lokal, yang dinyatakan dalam format ISO-8601. Misalnya, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

Nilai Properti

Date

localTimezone

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

localTimezone: string

Nilai Properti

string

membersAdded

Kumpulan anggota ditambahkan ke percakapan.

membersAdded?: ChannelAccount[]

Nilai Properti

ChannelAccount[]

membersRemoved

Kumpulan anggota dihapus dari percakapan.

membersRemoved?: ChannelAccount[]

Nilai Properti

ChannelAccount[]

name

Nama operasi yang terkait dengan aktivitas pemanggilan atau peristiwa.

name?: ActivityEventNames | string

Nilai Properti

ActivityEventNames | string

reactionsAdded

Kumpulan reaksi ditambahkan ke percakapan.

reactionsAdded?: MessageReaction[]

Nilai Properti

MessageReaction[]

reactionsRemoved

Kumpulan reaksi dihapus dari percakapan.

reactionsRemoved?: MessageReaction[]

Nilai Properti

MessageReaction[]

recipient

Mengidentifikasi penerima pesan.

recipient: ChannelAccount

Nilai Properti

ChannelAccount

relatesTo

Referensi ke percakapan atau aktivitas lain.

relatesTo?: ConversationReference

Nilai Properti

ConversationReference

replyToId

Berisi ID pesan di mana pesan ini adalah balasan.

replyToId?: string

Nilai Properti

string

semanticAction

Tindakan terprogram opsional yang menyertai permintaan ini

semanticAction?: SemanticAction

Nilai Properti

SemanticAction

serviceUrl

Berisi URL yang menentukan titik akhir layanan saluran. Diatur oleh saluran.

serviceUrl: string

Nilai Properti

string

speak

Teks yang akan diucapkan.

speak?: string

Nilai Properti

string

suggestedActions

Tindakan yang disarankan untuk aktivitas tersebut.

suggestedActions?: SuggestedActions

Nilai Properti

SuggestedActions

summary

Teks yang akan ditampilkan jika saluran tidak dapat merender kartu.

summary?: string

Nilai Properti

string

text

Konten teks pesan.

text: string

Nilai Properti

string

textFormat

Format bidang teks Default:markdown. Nilai yang mungkin termasuk: 'markdown', 'plain', 'xml'

textFormat?: TextFormatTypes | string

Nilai Properti

TextFormatTypes | string

textHighlights

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

textHighlights?: TextHighlight[]

Nilai Properti

TextHighlight[]

timestamp

Berisi tanggal dan waktu pesan dikirim, dalam UTC, yang dinyatakan dalam format ISO-8601.

timestamp?: Date

Nilai Properti

Date

topicName

Nama topik percakapan yang diperbarui.

topicName?: string

Nilai Properti

string

type

Berisi jenis aktivitas. Nilai yang mungkin termasuk: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

type: ActivityTypes | string

Nilai Properti

ActivityTypes | string

value

Nilai yang terkait dengan aktivitas.

value?: any

Nilai Properti

any

valueType

Jenis objek nilai aktivitas.

valueType: string

Nilai Properti

string