channels.stop: Stops watching resources through this channel.

Description Usage Arguments Details See Also

View source: R/channels.R

Description

Autogenerated via package_make.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
channels.stop(
  params = NULL,
  expiration = NULL,
  payload = NULL,
  type = NULL,
  kind = NULL,
  address = NULL,
  resourceUri = NULL,
  token = NULL,
  id = NULL,
  resourceId = NULL,
  callback = NULL,
  fields = NULL,
  uploadType = NULL,
  upload_protocol = NULL,
  prettyPrint = NULL,
  quotaUser = NULL,
  alt = NULL,
  gargle_token = gargle::token_fetch(scopes =
    .endpoints[["admin.channels.stop"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

params

Additional parameters controlling delivery channel behavior. Optional.

expiration

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

payload

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

type

The type of delivery mechanism used for this channel.

kind

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

address

The address where notifications are delivered for this channel.

resourceUri

A version-specific identifier for the watched resource.

token

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

id

A UUID or similar unique string that identifies this channel.

resourceId

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

callback

JSONP

fields

Selector specifying which fields to include in a partial response.

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

prettyPrint

Returns response with indentations and line breaks.

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

alt

Data format for response.

gargle_token

A token prepared by one of gargle's token generating functions. Defaults to gargle::token_fetch(...) with appropriate scopes. See token_fetch for more info.

return_request

Whether to return the request without making it. Defaults to FALSE. See request_build for more info on the returned request object.

return_response

Whether to return the response or the response content. Defaults to FALSE (return response content).

Details

Authentication scopes used by this function are:

See Also

Google Documentation


samterfa/gapiAdminSDK documentation built on Dec. 22, 2021, 10:11 p.m.