REST Resource: channels

Recurso: canal

Um canal de notificação usado para observar alterações de recursos.

Representação JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Campos
payload

boolean

Um valor booleano para indicar se o payload é desejado. Opcional.

id

string

Um UUID ou uma string exclusiva semelhante que identifica este canal.

resourceId

string

Um ID opaco que identifica o recurso que está sendo monitorado no canal. Estável em diferentes versões da API.

resourceUri

string

Um identificador específico da versão para o recurso monitorado.

token

string

Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por esse canal. Opcional.

expiration

string (int64 format)

Data e hora da expiração do canal de notificação, expressa como um carimbo de data/hora Unix, em milissegundos. Opcional.

type

string

O tipo de mecanismo de envio usado para este canal. Os valores válidos são "web_hook" ou "webhook".

address

string

O endereço em que as notificações são enviadas para esse canal.

params

map (key: string, value: string)

Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

kind

string

Identifica isso como um canal de notificação usado para observar mudanças em um recurso, que é api#channel.

Métodos

stop

Para de assistir a recursos por este canal.