Google Chat API: Node.js Client

Google Chat API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Google Chat API API .
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @google-apps/chat

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Optional. The maximum number of spaces to return. The service might return
 *  fewer than this value.
 *  If unspecified, at most 100 spaces are returned.
 *  The maximum value is 1,000. If you use a value more than 1,000, it's
 *  automatically changed to 1,000.
 *  Negative values return an `INVALID_ARGUMENT` error.
 */
// const pageSize = 1234
/**
 *  Optional. A page token, received from a previous list spaces call.
 *  Provide this parameter to retrieve the subsequent page.
 *  When paginating, the filter value should match the call that provided the
 *  page token. Passing a different value may lead to unexpected results.
 */
// const pageToken = 'abc123'
/**
 *  Optional. A query filter.
 *  You can filter spaces by the space type
 *  (`space_type` (https://developers.google.com/chat/api/reference/rest/v1/spaces#spacetype)).
 *  To filter by space type, you must specify valid enum value, such as
 *  `SPACE` or `GROUP_CHAT` (the `space_type` can't be
 *  `SPACE_TYPE_UNSPECIFIED`). To query for multiple space types, use the `OR`
 *  operator.
 *  For example, the following queries are valid:
 *  ```
 *  space_type = "SPACE"
 *  spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
 *  ```
 *  Invalid queries are rejected by the server with an `INVALID_ARGUMENT`
 *  error.
 */
// const filter = 'abc123'

// Imports the Chat library
const {ChatServiceClient} = require(' @google-apps/chat 
').v1;

// Instantiates a client
const chatClient = new ChatServiceClient 
();

async function callListSpaces() {
  // Construct request
  const request = {};

  // Run request
  const iterable = chatClient. listSpacesAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListSpaces();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Chat_service.complete_import_space	source code
Chat_service.create_membership	source code
Chat_service.create_message	source code
Chat_service.create_reaction	source code
Chat_service.create_space	source code
Chat_service.delete_membership	source code
Chat_service.delete_message	source code
Chat_service.delete_reaction	source code
Chat_service.delete_space	source code
Chat_service.find_direct_message	source code
Chat_service.get_attachment	source code
Chat_service.get_membership	source code
Chat_service.get_message	source code
Chat_service.get_space	source code
Chat_service.get_space_read_state	source code
Chat_service.get_thread_read_state	source code
Chat_service.list_memberships	source code
Chat_service.list_messages	source code
Chat_service.list_reactions	source code
Chat_service.list_spaces	source code
Chat_service.set_up_space	source code
Chat_service.update_membership	source code
Chat_service.update_message	source code
Chat_service.update_space	source code
Chat_service.update_space_read_state	source code
Chat_service.upload_attachment	source code
Quickstart	source code

The Google Chat API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-apps/chat@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE