REST Resource: channels

Tài nguyên: Kênh

Một 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
{
  "params": {
    string: string,
    ...
  },
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "kind": string
}
Trường
params

map (key: string, value: string)

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 "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

payload

boolean

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

string

Một UUID hoặc chuỗi duy nhất tương tự dùng để xác định kênh này.

resourceId

string

Mã nhận dạng 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

string

Giá trị nhận dạng dành riêng cho phiên bản của tài nguyên được theo dõi.

token

string

Một chuỗi tuỳ ý được gửi đến địa chỉ đích cùng với mỗi thông báo được gửi qua kênh này. Không bắt buộc.

expiration

string (int64 format)

Ngày và giờ hết hạn của kênh thông báo, được biểu thị dưới dạng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc.

type

string

Loại cơ chế phân phối được dùng cho kênh này. Các giá trị hợp lệ là "web_hook" hoặc "webhook".

address

string

Địa chỉ nhận thông báo cho kênh này.

kind

string

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, đó là api#channel.

Phương thức

stop

Dừng xem tài nguyên thông qua kênh này.