ContextQMD
Back to Google Cloud Node

[Google Chat API: Nodejs Client][homepage]

packages/google-chat/README.md

0.57.010.5 KB
Original Source

Google Chat API: Nodejs Client

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.

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

bash
npm install @google-apps/chat

Samples

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

SampleSource Code
complete import spacesource code
create custom emojisource code
create membershipsource code
create messagesource code
create reactionsource code
create spacesource code
delete custom emojisource code
delete membershipsource code
delete messagesource code
delete reactionsource code
delete spacesource code
find direct messagesource code
get attachmentsource code
get custom emojisource code
get membershipsource code
get messagesource code
get spacesource code
get space eventsource code
get space notification settingsource code
get space read statesource code
get thread read statesource code
list custom emojissource code
list membershipssource code
list messagessource code
list reactionssource code
list space eventssource code
list spacessource code
search spacessource code
set up spacesource code
update membershipsource code
update messagesource code
update spacesource code
update space notification settingsource code
update space read statesource code
upload attachmentsource code
chatsource 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