הפניית API

הממשק של מופע ה-SDK לאינטרנט ccaas.

מאפיינים

בקטע הזה מפורטים חלק מהמאפיינים שאפשר להשתמש בהם.

גרסה

גרסת ה-SDK לאתר.

console.log(ccaas.VERSION)

לקוח

זוהי דוגמה ללקוח ללא ממשק גרפי, והיא כוללת את כל מה שזמין בלקוח ללא ממשק גרפי.

לדוגמה:

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

Methods

השיטות הזמינות במופע הווידג'ט.

.config

מעדכנים את ההגדרות של הווידג'ט.

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

מידע נוסף זמין בקטע הגדרה.

‎.mount

הוספת הווידג'ט לרכיב שצוין. לדוגמה, בדף האינטרנט שלכם:

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

אחר כך אפשר להוסיף את הווידג'ט של ה-SDK לאתר באמצעות הפקודה:

ccaas.mount('#my-ccaas')

.unmount

מסירים את הווידג'ט של ערכת ה-SDK לאינטרנט מדף האינטרנט.

ccaas.unmount()

‎.destroy

ביטול הטעינה ומחיקה של הכול.

ccaas.destroy()

‎.show

הצגת ממשק המשתמש של הווידג'ט.

ccaas.show()

‎.hide

להסתיר את ממשק המשתמש של הווידג'ט.

ccaas.hide()

‎.start

הצגה והפעלה של הווידג'ט עם האפשרויות שצוינו.

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

דוגמה:

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

אירועים

בקטע הזה מתוארים האירועים שזמינים ב-SDK לאתרים. רשימה מלאה של האירועים שזמינים ב-SDK headless web מופיעה במאמר אירועים ב-SDK headless web.

משתמשים ב-.on method כדי להוסיף event listener. מקרה לדוגמה:

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

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

משתמשים ב-.off method כדי להסיר event listener. מקרה לדוגמה:

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

השיטות .on ו-.off הן כינויים לשיטות .on ו-.off של ערכת ה-SDK של headless web. מידע נוסף זמין במדריך ל-SDK של אינטרנט ללא ממשק משתמש.

גלוי

האירוע הזה מופעל כשמשתנה סטטוס החשיפה של הווידג'ט (פתיחה או סגירה).

בדוגמה הבאה מוצג האירוע visible:

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

chat.unread

האירוע מופעל כשמספר ההודעות שלא נקראו משתנה.

בדוגמה הבאה מוצג האירוע chat.unread:

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

יצאו

האירוע מופעל כשמשתמש הקצה סוגר את הווידג'ט והסשן מסתיים.

בדוגמה הבאה מוצג האירוע exited:

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