Tài nguyên: Kênh
Kênh thông báo dùng để theo dõi các thay đổi về tài nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "payload": boolean, "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": string, "type": string, "address": string, "params": { string: string, ... }, "kind": string } |
Trường | |
---|---|
payload |
Giá trị Boolean để cho biết liệu có cần tải trọng hay không. Không bắt buộc. |
id |
Mã nhận dạng duy nhất (UUID) hoặc chuỗi duy nhất tương tự nhận dạng kênh này. |
resourceId |
ID mờ xác định tài nguyên đang được xem trên kênh này. Ổn định trên nhiều phiên bản API. |
resourceUri |
Giá trị nhận dạng theo phiên bản cụ thể của tài nguyên được xem. |
token |
Một chuỗi tuỳ ý được gửi tới địa chỉ đích, trong đó mỗi thông báo được gửi qua kênh này. Không bắt buộc. |
expiration |
Ngày và thời gian hết hạn kênh thông báo, được biểu thị bằng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc. |
type |
Loại cơ chế phân phối được sử dụng cho kênh này. Các giá trị hợp lệ là "web_hook" hoặc "webhook". |
address |
Địa chỉ nhận thông báo cho kênh này. |
params |
Các tham số bổ sung kiểm soát hành vi của kênh phân phối. Không bắt buộc. Một đối tượng chứa danh sách các cặp |
kind |
Xác định đây là một kênh thông báo dùng để theo dõi các thay đổi đối với một tài nguyên, tức là |
Phương thức |
|
---|---|
|
Dừng xem tài nguyên qua kênh này. |