conectar

Este método cria e retorna uma instância de um objeto Socket.io com uma conexão. Este método requer autorização obrigatória do usuário.

const socket = await WS.connect()

socket.on('my_event', callback)

Quando os atributos mudam (se o usuário estiver inscrito no evento correspondente e a opção Websocket estiver ativa no evento) O campo "attributes" sempre contém os atributos do evento (o campo "events"), e dependendo do tipo de evento selecionado para o catálogo ou formulário, os campos com os atributos "product" contêm atributos do produto, e "user" contém campos do formulário do usuário, respectivamente. Para um produto, há um campo adicional "title" (nome do produto como uma string), e para formulários de registro e envio de código, há campos adicionais "code" e "email."

O valor do atributo é armazenado no formato *key - marcador*, *value - {tipo, identificador, valor}*.

Exemplo:

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

Esquema

message string
Mensagem de texto
exemplo: Mensagem

attributes: Record<string, any>
Contém atributos do evento
exemplo:

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

Exemplo de Produto:

{
  "product": {
    "id": 10,
    "info": {
      "title": "Planeta Rosa",
    },
    "status": {
      "identifier": "disponível",
      "info": {
        "title": "ADICIONAR AO CARRINHO"
      }
    },
    "attributes": {
      "currency": {
        "identifier": "moeda",
        "type": "string",
        "value": "USD"
      }
    }
  }
}

Exemplo de Usuário:

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

Exemplo de Pedido:

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

Exemplo de Formulário:

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