Méthodes disponibles

isOpen

DestygoChat.isOpen() renvoie true si la fenêtre de chat du widget est ouverte et false sinon.

wasOpened

DestygoChat.wasOpened() renvoie true si la fenêtre de chat du widget a déjà été ouverte au moins une fois et false sinon.

unreadMessagesCount

DestygoChat.unreadMessagesCount() renvoie le nombre de messages non lus. Un message est non lu s'il a été reçu alors que la fenêtre de chat était fermée et qu'elle n'a pas été ouverte depuis.

messages

DestygoChat.messages() renvoie la liste des messages du widget en cours. Le résultat est un tableau d'objets pouvant prendre les deux formes suivantes : { "author": "'user'||'server'", "text": "the text of the message" } { "author": "'user'||'server'", "attachment": {type: "template", payload: {…}} } L'auteur peut être user ou server. Le payload contient soit text, soit attachment. Un attachment est un modèle de données JSON.

MarkMessagesAsRead

DestygoChat.MarkMessagesAsRead() marque tous les messages non lus comme lus.

ToggleChat

Paramètre facultatif : open (booléen) DestygoChat.ToggleChat() ouvre ou ferme la fenêtre de chat selon son paramètre. * DestygoChat.ToggleChat() ouvre la fenêtre de chat si elle était fermée, et la ferme si elle était ouverte. * DestygoChat.ToggleChat({open: true}) ouvre la fenêtre de chat quel que soit son état. * DestygoChat.ToggleChat({open: false}) ferme la fenêtre de chat quel que soit son état.

SendMessage

Paramètre obligatoire : message texte (chaîne) DestygoChat.SendMessage('a text message') envoie un message texte au bot.

ResetWidget

DestygoChat.ResetWidget() réinitialise l'état du widget, comme s'il s'agissait d'un tout nouvel utilisateur.

setZendeskUserInfo

Paramètre obligatoire : informations utilisateur : display_name, email, phone (objet) L'objet passé en paramètre ne peut contenir que ces trois champs : display_name, email, phone. Cette restriction vient de Zendesk et nous ne pouvons pas ajouter d'autres champs. DestygoChat.setZendeskUserInfo(UserInfoObject) envoie les informations de l'utilisateur à Zendesk avant l'Agent Handover. Vous devez utiliser cette fonction lorsque l'événement suivant est déclenché : destygo_zendesk_triggered