Référence API

OptaveJavaScriptSDK(options)

Crée une nouvelle instance de l'OptaveJavaScriptSDK.

Paramètres

• options (Object) : Options de configuration.
  • websocketUrl (string) : L'URL WebSocket.
  • authenticationUrl (string, optionnel) : L'URL d'authentification.
  • clientId (string, optionnel) : L'ID client pour l'authentification.
  • clientSecret (string, optionnel) : Le secret client pour l'authentification.

authenticate()

Authentifie le client en utilisant les identifiants fournis et récupère un token d'accès.

• Retourne : Promise<string> : Le token d'accès.

openConnection(bearerToken)

Établit une connexion WebSocket en utilisant le token bearer fourni.

Paramètres

• bearerToken (string) : Le token d'authentification.

closeConnection()

Ferme la connexion WebSocket active.

send(requestType, action, params, version)

Envoie un message à travers la connexion WebSocket.

• Paramètres :
  • requestType (string) : Le type de la requête.
  • action (string) : L'action spécifique à effectuer.
  • params (Object) : Les paramètres pour la requête.
  • version (number, optionnel) : La version du payload (par défaut 2).

Méthodes Prédéfinies

Ces méthodes sont des raccourcis pour envoyer des types spécifiques de messages.

• customerInteraction(params) : Envoie un message customerinteraction.
• elevate(params) : Envoie un message elevate.
• adjust(params) : Envoie un message adjust.
• summarize(params) : Envoie un message summarize.
• translate(params) : Envoie un message translate.
• recommend(params) : Envoie un message recommend.
• insights(params) : Envoie un message insights.

Méthodes EventEmitter

Puisque OptaveJavaScriptSDK étend EventEmitter, vous pouvez utiliser toutes les méthodes standard EventEmitter telles que on, once, emit, etc.