Ana içeriğe geç

bağlan

Bu yöntem, bir bağlantı ile bir Socket.io nesnesinin örneğini oluşturur ve döndürür. Bu yöntem, kullanıcı yetkilendirmesi gerektirir.

Açıklama​

Öznitelikler değiştiğinde (kullanıcı ilgili olaya abone ise ve olayda Websocket seçeneği aktifse) "attributes" alanı her zaman olay özniteliklerini ( "events" alanı) içerir ve katalog veya form için seçilen olay türüne bağlı olarak, "product" öznitelikleri ürün özniteliklerini, "user" ise kullanıcı formundan alanları içerir. Bir ürün için ek bir "title" (ürün adı olarak bir dize) alanı vardır ve kayıt ve kod gönderim formları için ek "code" ve "email" alanları bulunmaktadır.

Öznitelik değeri *key - işaretçi*, *value - {type, identifier, value}* formatında saklanır.

Örnekler​

Minimal örnek​

const socket = await WS.connect();

socket.on('my_event', callback);

Ürün Örneği:​

{
  "product": {
    "id": 10,
    "info": {
      "title": "Pembe Gezegen",
    },
    "status": {
      "identifier": "available",
      "info": {
        "title": "SEPETE EKLE"
      }
    },
    "attributes": {
      "currency": {
        "identifier": "currency",
        "type": "string",
        "value": "USD"
      }
    }
  }
}

Kullanıcı Örneği:​

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

Sipariş Örneği:​

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

Form örneği:​

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

Örnek yanıt​

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

Yanıt şeması​

Şema: Socket

message string
Metin mesajı
örnek: Mesaj

attributes: Record<string, any>
Olay özniteliklerini içerir
örnek:

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