Interface Schema$Channel

An notification channel used to watch for resource changes.

Hierarchy

  • Schema$Channel

Properties

address? expiration? id? kind? params? payload? resourceId? resourceUri? token? type?

Properties

Optional address

address?: string

The address where notifications are delivered for this channel.

Optional expiration

expiration?: string

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Optional id

id?: string

A UUID or similar unique string that identifies this channel.

Optional kind

kind?: string

Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

Optional params

params?: {
    [key: string]: string;
}

Additional parameters controlling delivery channel behavior. Optional.

Type declaration

  • [key: string]: string

Optional payload

payload?: boolean

A Boolean value to indicate whether payload is wanted. Optional.

Optional resourceId

resourceId?: string

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Optional resourceUri

resourceUri?: string

A version-specific identifier for the watched resource.

Optional token

token?: string

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Optional type

type?: string

The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.

Settings

Member Visibility

Theme

Generated using TypeDoc