Class Resource$Channels

stop

• stop(params: Params$Resource$Channels$Stop, options: StreamMethodOptions): GaxiosPromise<Readable>

• Stop watching resources through this channel

  Example

  // Before running the sample:
  // - Enable the API at:
  //   https://console.developers.google.com/apis/api/drive.googleapis.com
  // - Login into gcloud by running:
  //   `$ gcloud auth application-default login`
  // - Install the npm module by running:
  //   `$ npm install googleapis`
  
  const {google} = require('googleapis');
  const drive = google.drive('v3');
  
  async function main() {
    const auth = new google.auth.GoogleAuth({
      // Scopes can be specified either as an array or as a single, space-delimited string.
      scopes: [
        'https://www.googleapis.com/auth/drive',
        'https://www.googleapis.com/auth/drive.appdata',
        'https://www.googleapis.com/auth/drive.file',
        'https://www.googleapis.com/auth/drive.metadata',
        'https://www.googleapis.com/auth/drive.metadata.readonly',
        'https://www.googleapis.com/auth/drive.photos.readonly',
        'https://www.googleapis.com/auth/drive.readonly',
      ],
    });
  
    // Acquire an auth client, and bind it to all future calls
    const authClient = await auth.getClient();
    google.options({auth: authClient});
  
    // Do the magic
    const res = await drive.channels.stop({
      // Request body metadata
      requestBody: {
        // request body parameters
        // {
        //   "address": "my_address",
        //   "expiration": "my_expiration",
        //   "id": "my_id",
        //   "kind": "my_kind",
        //   "params": {},
        //   "payload": false,
        //   "resourceId": "my_resourceId",
        //   "resourceUri": "my_resourceUri",
        //   "token": "my_token",
        //   "type": "my_type"
        // }
      },
    });
    console.log(res.data);
  }
  
  main().catch(e => {
    console.error(e);
    throw e;
  });
  
  

  Returns

  A promise if used with async/await, or void if used with a callback.

  Parameters

  • params: Params$Resource$Channels$Stop

    Parameters for request

  • options: StreamMethodOptions

    Optionally override request options, such as url, method, and encoding.

  Returns GaxiosPromise<Readable>

• stop(params?: Params$Resource$Channels$Stop, options?: MethodOptions): GaxiosPromise<void>

• Parameters

  • Optional params: Params$Resource$Channels$Stop

  • Optional options: MethodOptions

  Returns GaxiosPromise<void>

• stop(params: Params$Resource$Channels$Stop, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void

• Parameters

  • params: Params$Resource$Channels$Stop

  • options: StreamMethodOptions | BodyResponseCallback<Readable>

  • callback: BodyResponseCallback<Readable>

  Returns void

• stop(params: Params$Resource$Channels$Stop, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void

• Parameters

  • params: Params$Resource$Channels$Stop

  • options: MethodOptions | BodyResponseCallback<void>

  • callback: BodyResponseCallback<void>

  Returns void

• stop(params: Params$Resource$Channels$Stop, callback: BodyResponseCallback<void>): void

• Parameters

  • params: Params$Resource$Channels$Stop

  • callback: BodyResponseCallback<void>

  Returns void

• stop(callback: BodyResponseCallback<void>): void

• Parameters

  • callback: BodyResponseCallback<void>

  Returns void