Saltar al contenido principal

conectar

Este método crea y devuelve una instancia de un objeto Socket.io con una conexión. Este método requiere autorización del usuario.

Descripción​

Cuando los atributos cambian (si el usuario está suscrito al evento correspondiente y la opción de Websocket está activa en el evento)
El campo "attributes" siempre contiene los atributos del evento (el campo "events"), y dependiendo del tipo de evento seleccionado para el catálogo o formulario, los campos con los atributos "product" contienen atributos del producto, y "user" contiene campos del formulario de usuario, respectivamente. Para un producto, hay un campo adicional "title" (nombre del producto como una cadena), y para los formularios de registro y envío de código, hay campos adicionales "code" y "email".

El valor del atributo se almacena en el formato *key - marker*, *value - {type, identifier, value}*.

Ejemplos​

Ejemplo mínimo​

// connect() is synchronous — do not await it.
const socket = WS.connect();

socket.on('my_event', callback);

ℹ️ socket.io-client se importa la primera vez que se llama a connect(), por lo que se mantiene fuera de los paquetes que nunca abren un socket. Los controladores registrados en el socket devuelto se encolan y se reproducen antes de que la conexión pueda entregar algo, por lo que nada se pierde — ver Tamaño del paquete y formatos de módulo.

Ejemplo de producto:​

{
  "product": {
    "id": 10,
    "info": {
      "title": "Pink Planet",
    },
    "status": {
      "identifier": "available",
      "info": {
        "title": "ADD TO CART"
      }
    },
    "attributes": {
      "currency": {
        "identifier": "currency",
        "type": "string",
        "value": "USD"
      }
    }
  }
}

Ejemplo de usuario:​

{
  "user": {
    "notificationData": {},
    "attributes": {}
  },
  "order": {
    "id": 1,
    "attributes": {}
  }
}

Ejemplo de pedido:​

{
  "user": {
    "notificationData": {},
    "attributes": {}
  },
  "order": {
    "id": 1,
    "attributes": {}
  }
}

Ejemplo de formulario:​

{
  "email": "string",
  "formData": {}
}

Ejemplo de respuesta​

{
    "message": "Message",
    "attributes": {
      "company": {
        "identifier": "company",
        "type": "string",
        "value": "OneEntry"
      }
    }
}

Esquema de respuesta​

Esquema: Socket

message string
Mensaje de texto
ejemplo: Mensaje

attributes: Record<string, any>
Contiene atributos del evento
ejemplo:

{
  "company": {
    "identifier": "company",
    "type": "string",
    "value": "OneEntry"
  }
}