REST Resource: channels

Risorsa: canale

Un canale di notifica utilizzato per controllare le modifiche alle risorse.

Rappresentazione JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Campi
payload

boolean

Un valore booleano che indica se si vuole il payload. (Facoltativo)

id

string

Un UUID o una stringa univoca simile che identifica questo canale.

resourceId

string

Un ID opaco che identifica la risorsa guardata su questo canale. Stabile su diverse versioni dell'API.

resourceUri

string

Un identificatore specifico della versione per la risorsa controllata.

token

string

Una stringa arbitraria inviata all'indirizzo di destinazione con ogni notifica inviata su questo canale. (Facoltativo)

expiration

string (int64 format)

Data e ora di scadenza del canale di notifica, espresse come timestamp Unix, in millisecondi. (Facoltativo)

type

string

Il tipo di meccanismo di pubblicazione utilizzato per questo canale. I valori validi sono "web_hook" o "webhook".

address

string

L'indirizzo a cui vengono recapitate le notifiche per questo canale.

params

map (key: string, value: string)

Parametri aggiuntivi che controllano il comportamento del canale di pubblicazione. (Facoltativo)

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Identifica questo canale come un canale di notifica utilizzato per controllare le modifiche a una risorsa, api#channel.

Metodi

stop

Interrompe la visualizzazione delle risorse su questo canale.