Documentation de référence de l'API

L'interface de l'instance du SDK Web ccaas.

Propriétés

Cette section contient certaines des propriétés que vous pouvez utiliser.

version

Version du SDK Web.

console.log(ccaas.VERSION)

Client

Il s'agit d'une instance du client headless, elle contient tout ce qui est disponible sur un client headless.

Voici un exemple :

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

Méthodes

Méthodes disponibles sur l'instance du widget.

.config

Mettez à jour la configuration du widget.

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

Pour en savoir plus, consultez la section Configuration.

.mount

Montez le widget sur l'élément donné. Par exemple, sur votre page Web :

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

Vous pouvez ensuite monter le widget du SDK Web avec :

ccaas.mount('#my-ccaas')

.unmount

Supprimez le widget du SDK Web de votre page Web.

ccaas.unmount()

.destroy

Démontez et détruisez tout.

ccaas.destroy()

.show

Affichez l'interface utilisateur du widget.

ccaas.show()

.hide

Masquez l'interface utilisateur du widget.

ccaas.hide()

.start

Affichez et démarrez le widget avec les options données.

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

Exemple :

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

Événements

Cette section décrit les événements disponibles dans le SDK Web. Pour obtenir la liste complète des événements disponibles dans le SDK Web headless, consultez la section Événements du SDK Web headless.

Utilisez la méthode .on pour ajouter un écouteur d'événements. Consultez l'exemple ci-dessous :

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

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

Utilisez la méthode .off pour supprimer un écouteur d'événements. Consultez l'exemple ci-dessous :

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

Les méthodes .on et .off sont des alias pour les méthodes .on et .off du SDK Web headless. Pour en savoir plus, consultez le guide du SDK Web headless.

visible

Émis lorsque la visibilité du widget change (ouverture ou fermeture).

L'exemple suivant montre l'événement visible :

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

chat.unread

Émis lorsque le nombre de messages non lus change.

L'exemple suivant montre l'événement chat.unread :

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

exited

Émis lorsque l'utilisateur final ferme le widget et que la session se termine.

L'exemple suivant montre l'événement exited :

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