Referensi API

Antarmuka instance SDK web ccaas.

Properti

Bagian ini berisi beberapa properti yang mungkin Anda gunakan.

versi

Versi SDK web.

console.log(ccaas.VERSION)

klien

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

Berikut ini contohnya:

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

Metode

Metode yang tersedia di 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 SDK web dengan:

ccaas.mount('#my-ccaas')

.unmount

Hapus widget SDK web dari halaman web Anda.

ccaas.unmount()

.destroy

Lepaskan dan hancurkan semuanya.

ccaas.destroy()

.show

Tampilkan UI widget.

ccaas.show()

.hide

Sembunyikan 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 mengetahui daftar lengkap peristiwa yang tersedia di SDK web headless, lihat Peristiwa SDK web headless events.

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 SDK web headless. Untuk mengetahui informasi selengkapnya, lihat Panduan SDK web headless.

terlihat

Dipancarkan saat visibilitas widget berubah (terbuka atau tertutup).

Contoh berikut menunjukkan peristiwa visible:

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

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

Dipancarkan saat pengguna akhir menutup widget dan sesi berakhir.

Contoh berikut menunjukkan peristiwa exited:

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