Chuyển đến nội dung chính

kết nối

Phương thức này tạo và trả về một thể hiện của đối tượng Socket.io với một kết nối. Phương thức này yêu cầu người dùng xác thực.

Mô tả

Khi các thuộc tính thay đổi (nếu người dùng đã đăng ký sự kiện tương ứng và tùy chọn Websocket đang hoạt động trong sự kiện) Trường "attributes" luôn chứa các thuộc tính sự kiện (trường "events"), và tùy thuộc vào loại sự kiện đã chọn cho danh mục hoặc biểu mẫu, các trường với thuộc tính "product" chứa các thuộc tính sản phẩm, và "user" chứa các trường từ biểu mẫu người dùng, tương ứng. Đối với một sản phẩm, có một trường bổ sung "title" (tên sản phẩm dưới dạng chuỗi), và đối với các biểu mẫu đăng ký và gửi mã, có các trường bổ sung "code" và "email."

Giá trị thuộc tính được lưu trữ theo định dạng *key - marker*, *value - {type, identifier, value}*.

Ví dụ

Ví dụ tối thiểu

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

socket.on('my_event', callback);

ℹ️ socket.io-client được nhập lần đầu tiên khi connect() được gọi, vì vậy nó không nằm trong các gói mà không bao giờ mở một socket. Các trình xử lý được đăng ký trên socket trả về sẽ được xếp hàng và phát lại trước khi kết nối có thể gửi bất kỳ thứ gì, vì vậy không có gì bị mất — xem Kích thước Gói & Định dạng Mô-đun.

Ví dụ Sản phẩm:

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

Ví dụ Người dùng:

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

Ví dụ Đơn hàng:

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

Ví dụ Biểu mẫu:

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: Socket

message chuỗi
Tin nhắn văn bản
ví dụ: Tin nhắn

attributes: Record<string, any>
Chứa các thuộc tính sự kiện
ví dụ:

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