connect

Metode ini membuat dan mengembalikan sebuah instance dari objek Socket.io dengan koneksi. Metode ini memerlukan otorisasi pengguna.

Deskripsi

Ketika atribut berubah (jika pengguna terdaftar pada event yang sesuai dan opsi Websocket aktif dalam event tersebut) Bidang "attributes" selalu berisi atribut event (bidang "events"), dan tergantung pada jenis event yang dipilih untuk katalog atau formulir, bidang dengan atribut "product" berisi atribut produk, dan "user" berisi bidang dari formulir pengguna, masing-masing. Untuk produk, ada bidang tambahan "title" (nama produk sebagai string), dan untuk formulir pendaftaran dan pengiriman kode, ada bidang tambahan "code" dan "email."

Nilai atribut disimpan dalam format *key - marker*, *value - {type, identifier, value}*.

Contoh

Contoh minimal

const socket = await WS.connect();

socket.on('my_event', callback);

Contoh Produk:

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

Contoh Pengguna:

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

Contoh Pesanan:

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

Contoh Formulir:

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

Contoh respons

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

Skema respons

Skema: Socket

message string
Pesan teks
contoh: Message

attributes: Record<string, any>
Berisi atribut event
contoh:

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

---