@maxim_mazurok/gapi.client.cloudiot-v1 v0.0.20230328

TypeScript typings for Cloud IoT API v1

Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. For detailed description please check documentation.

Installing

Install typings for Cloud IoT API:

npm install @types/gapi.client.cloudiot-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load('https://cloudiot.googleapis.com/$discovery/rest?version=v1', () => {
  // now we can use:
  // gapi.client.cloudiot
});

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('cloudiot', 'v1', () => {
  // now we can use:
  // gapi.client.cloudiot
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
      // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
      'https://www.googleapis.com/auth/cloud-platform',

      // Register and manage devices in the Google Cloud IoT service
      'https://www.googleapis.com/auth/cloudiot',
    ],
    immediate = true;
// ...

gapi.auth.authorize(
  { client_id: client_id, scope: scope, immediate: immediate },
  authResult => {
    if (authResult && !authResult.error) {
        /* handle successful authorization */
    } else {
        /* handle authorization error */
    }
});

After that you can use Cloud IoT API resources: