Skip to content

Latest commit

 

History

History

README.md

Google Cloud Platform logo

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.

npm version

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

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Chat API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-apps/chat

Samples

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

Sample Source Code
complete import space source code
create custom emoji source code
create membership source code
create message source code
create reaction source code
create space source code
delete custom emoji source code
delete membership source code
delete message source code
delete reaction source code
delete space source code
find direct message source code
get attachment source code
get custom emoji source code
get membership source code
get message source code
get space source code
get space event source code
get space notification setting source code
get space read state source code
get thread read state source code
list custom emojis source code
list memberships source code
list messages source code
list reactions source code
list space events source code
list spaces source code
search spaces source code
set up space source code
update membership source code
update message source code
update space source code
update space notification setting source code
update space read state source code
upload attachment source code
chat source code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE