Referensi API

Antarmuka instance Web SDK ccaas.

Properti

Bagian ini berisi beberapa properti yang mungkin Anda gunakan.

versi

Versi web SDK.

console.log(ccaas.VERSION)

klien

Ini adalah instance Headless client, yang berisi semua yang tersedia di headless client.

Berikut ini contohnya:

const client = ccaas.client
const chat = await client.loadOngoingChat()

Metode

Metode yang tersedia pada instance widget.

.config

Perbarui konfigurasi widget.

ccaas.config({
  accent: 'green'
})

Untuk mengetahui informasi selengkapnya, lihat bagian Konfigurasi.

.mount

Pasang widget pada elemen yang diberikan. Misalnya, di halaman web Anda:

<div id="my-ccaas"></div>

Kemudian, Anda dapat memasang widget web SDK dengan:

ccaas.mount('#my-ccaas')

.unmount

Hapus widget SDK web dari halaman web Anda.

ccaas.unmount()

.destroy

Lepaskan dan hancurkan semuanya.

ccaas.destroy()

.show

Menampilkan UI widget.

ccaas.show()

.hide

Menyembunyikan UI widget.

ccaas.hide()

.start

Tampilkan dan mulai widget dengan opsi yang diberikan.

interface StartOption {
  menuKey?: string;
  ticketId?: string;
  preferredChannel?: string;
}

Contoh:

ccaas.start({ menuKey: 'vip' })

Acara

Bagian ini menjelaskan peristiwa yang tersedia di SDK web. Untuk daftar lengkap peristiwa yang tersedia di headless web SDK, lihat Peristiwa headless web SDK.

Gunakan metode .on untuk menambahkan pemroses peristiwa. Lihat contoh berikut:

const trackChat = (chat) => {
  console.log(chat)
}

ccaas.on('chat.updated', trackChat)

Gunakan metode .off untuk menghapus pemroses peristiwa. Lihat contoh berikut:

ccaas.off('chat.updated', trackChat)

Metode .on dan .off adalah alias untuk metode .on dan .off headless web SDK. Untuk mengetahui informasi selengkapnya, lihat panduan SDK web tanpa UI.

terlihat

Peristiwa visible dipancarkan saat widget siap untuk komunikasi.

Contoh berikut menunjukkan peristiwa visible:

ccaas.on('visible', (visible) => {
  console.log(visible)  // true or false
})

chat.unread

Peristiwa chat.unread dipancarkan saat jumlah pesan yang belum dibaca berubah.

Contoh berikut menunjukkan peristiwa chat.unread:

ccaas.on('chat.unread', (count) => {
  console.log(count)
})

keluar

Peristiwa exited dipancarkan saat pengguna akhir menutup widget.

Contoh berikut menunjukkan peristiwa exited:

ccaas.on('exited', () => {
  // widget was exited
})