Métodos públicos en Javascript – Oct8ne

Oct8ne pone a disposicion de los clientes una serie de funciones javascript,  ya establecidas, para poder realizar ciertos  comportameintos.  De esta forma, el cliente final, podrá inovocar aquellas funciones que desee para lograr el objetivo que se ha propuesto.

Estos métodos se pueden llamar desde las páginas web de los clientes a través de SU PROPIO JAVASCRIPT.

En esta pequeña documentación se recopilan todos los métodos que se pueden invocar.

MÉTODOS GENERALES

oct8ne.open(enterType:string, message:string)

Inicia  Oct8ne con un ‘tipo de entrada’  y un primer mensaje de chat, enviado como agente.

0. Esta función soporta 2 parámetros opcionales:

enterType: Es un string que puede tomar los valores: ‘TRIGGER’, ‘CUSTOM’, ‘LIVECHAT’. Si no se especifica el tipo de entrada, será TRIGGER.

message: Corresponde al mensaje que se quiere dar al inicio de esa sesión.

0. Esta función no devuelve nada como respuesta.

oct8ne.isVisible()

Consulta en la settings del cliente, si el chat está activo (o no) en la web.

2. Esta función no soporta parámetros.
3. Esta función devuelve un booleano como respuesta; ‘true’ en caso de estar activo y ‘false’ en caso de estar apagado.

oct8ne.getVisitorStatus()

Consulta el estado del visitante.

4. Esta función no soporta parámetros.
5. Esta función devuelve un string. (‘Just Looking’, ‘Waiting’, ‘Attending’) dependiendo del estado en que se encuentre el visitante en el momento de realizar la llamada.

oct8ne.agentsAvailable()

Consulta la disponibilidad de agentes en el momento de ser invocada.

6. Esta función no soporta parámetros.
7. Esta función devuelve un booleano; ‘true’ en caso de que agentes estén conectados y ‘false’ en caso de que no haya agentes conectados al panel de Oct8ne.

oct8ne.isMobile()

Consulta si el cliente está navegando a través de un dispositivo móvil (o no)

8. Esta función no soporta parámetros.
9. Esta función devuelve un booleano; ‘true’ en caso de que sea un dispositivo móvil y ‘false’ en caso de que se trate de otro dispositivo (pc sobremesa)

oct8ne.updateTriggerValue(key:string, value:string)

Este método actualiza los valores de la propiedad de oct8ne.customData que le indiquemos y reevalúa los triggers.Solo se usa en caso de que el objeto ‘oct8ne.cusomData’ esté insertado en la página.

1. Esta función soporta 2 parámetros:

key: Es un string que corresponde a la propiedad que queramos actualizar.

value: Es un string que contiene el valor nuevo que se quiere dar al trigger.

9. Esta función no devuelve nada como respuesta.

oct8ne.restart()

Esta función recarga el api de Oct8ne, simulando un cambio de página.

12. Esta función no soporta parámetros.
13. Esta función no devuelve nada como respuesta.
14. Útil para entornos SPA

oct8ne.updateOct8neOptions(object:object)

Método que actualiza variables de contexto para que el agente las vea reflejadas en el panel de Oct8ne.

3. Esta función soporta 1 parámetros obligatorio. Debe ser un objeto clave:valor con las variables a actualizar o añadir.
4. Esta función no devuelve nada como respuesta.

Ejemplo:   var object = {       ‘id’:’123456’,       ‘location’:’Barcelona’       } oct8ne.updateOct8neOptions(object);

METODOS RELACIONADOS CON EL TAMAÑO DEL VISOR.

Modifican el tamaño del chat. 

Para que estos métodos funcionen correctamente, debe existir una sesión iniciada en el chat de Oct8ne anteriormente.

oct8ne.ui.showMinimized()

Minimiza el visor de Oct8ne.

14. Esta función no soporta parámetros.
15. Esta función no devuelve nada como respuesta.

oct8ne.ui.showChat()

Abre Oct8ne, sólo con el tamaño del módulo del chat. 

16. Esta función no soporta parámetros.
17. Esta función no devuelve nada como respuesta.

oct8ne.ui.showCoviewer()

Abre Oct8ne completamente; es decir, muestra el módulo del chat + el covisor (si la configuración del cliente lo permite).

18. Esta función no soporta parámetros.
19. Esta función no devuelve nada como respuesta.

METODOS RELACIONADOS CON EL BOT

oct8ne.bot.getContext()

Recoge los valores de las variables del visitante en el bot.

20. Esta función no soporta parámetros.
21. Esta función no devuelve nada como respuesta.

oct8ne.bot.updateBotContext(updateVars: object)

Actualiza los valores de las variables de contexto del visitante en el Bot. Solo se usa en caso de que el objeto ‘oct8ne.options’ esté insertado en la página.

5. Esta función soporta 1 parámetros obligatorio. Debe ser un objeto clave: valor con las variables a actualizar.
6. Esta función no devuelve nada como respuesta.

oct8ne.bot.gotoHome()

Al ejecutar este método, el bot  va al nodo inicial del árbol principal que tenga definido.

22. Esta función no soporta parámetros.
23. Esta función no devuelve nada como respuesta.

oct8ne.bot.gotoAction(treeId: int, nodeId: string)

Al ejecutar este método, la conversación actual ‘se mueve’ a un nodo específico de algun árbol.

6. Esta función soporta 2 parámetros opcionales:

treeId: Es un int que hace referencia al árbol elegido.

nodeId: Corresponde al nodo/modulo al que se quiere dirigir

23. Esta función no devuelve nada como respuesta.

•    Si sólo se indica el treeId, se va al nodo inicial del árbol especificado.

•    Si se indican treeId y nodeId, salta al nodo y árbol indicado.

•    Si se usa sin parámetros, va al nodo inicial del árbol principal (equivalente a 

oct8ne.bot.gotoHome().)

CONSIDERACION ADICIONAL

Si TODOS estos métodos se añaden al cargar la página, se deben añadir dentro de un callback de algún evento que asegure que Oct8ne ya ha sido cargado, como oct8ne.onReady. oct8ne.onReady = function () {     oct8ne.bot.gotoHome(); };