REST Resource: channels

Ressource: Channel

Ein Benachrichtigungskanal, der verwendet wird, um nach Ressourcenänderungen zu suchen.

JSON-Darstellung 
{
  "params": {
    string: string,
    ...
  },
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "kind": string
}
Felder
params

map (key: string, value: string)

Zusätzliche Parameter zur Steuerung des Verhaltens des Auslieferungskanals. Optional.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
payload

boolean

Ein boolescher Wert, der angibt, ob eine Nutzlast gewünscht wird. Optional.
id

string

Eine UUID oder ein ähnlicher eindeutiger String, der diesen Channel identifiziert.
resourceId

string

Eine intransparente ID, die die auf diesem Kanal überwachte Ressource identifiziert. Stabil über verschiedene API-Versionen hinweg.
resourceUri

string

Eine versionsspezifische Kennung für die überwachte Ressource.
token

string

Ein beliebiger String, der mit jeder Benachrichtigung, die über diesen Kanal gesendet wird, an die Zieladresse übermittelt wird. Optional.
expiration

string (int64 format)

Datum und Uhrzeit des Ablaufs des Benachrichtigungschannels als Unix-Zeitstempel in Millisekunden. Optional.
type

string

Der Typ des für diesen Channel verwendeten Bereitstellungsmechanismus. Gültige Werte sind „web_hook“ oder „webhook“.
address

string

Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden.
kind

string

Gibt an, dass dies ein Benachrichtigungskanal ist, der verwendet wird, um Änderungen an einer Ressource zu beobachten, die api#channel ist.

Methoden

stop

 Die Wiedergabe von Ressourcen über diesen Kanal wird beendet.