Miss any of our Open RFC calls?Watch the recordings here! »

@broid/gitter

2.2.0 • Public • Published

npm node deps tests bithound bithoundscore nsp-checked

Broid Gitter Integration

Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.

Connect your App to Multiple Messaging Channels with One OpenSource Language.

gitter

Message types supported

Simple Image Video Buttons Location Phone number

Buttons, Location, Phone number are platform limitations.

Getting started

Install

npm install --save @broid/gitter

Connect to Gitter

const BroidGitter = require('@broid/gitter');
 
const gitter = new BroidGitter({
  token: '<your_action_name_here>'
});
 
gitter.connect()
  .subscribe({
    next: data => console.log(data),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Options available

name Type default Description
serviceID string random Arbitrary identifier of the running instance
logLevel string info Can be : fatal, error, warn, info, debug, trace
token string Gitter token.

Receive a message

gitter.listen()
  .subscribe({
    next: data => console.log(`Received message: ${data}`),
    error: err => console.error(`Something went wrong: ${err.message}`),
    complete: () => console.log('complete'),
  });

Post a message

To send a message, the format should use the broid-schemas.

const formatted_message = {
  "@context": "https://www.w3.org/ns/activitystreams",
  "type": "Create",
  "generator": {
    "id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
    "type": "Service",
    "name": "gitter"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "id": "588f9929d73402ce4f470489",
    "type": "Group"
  }
};
 
gitter.send(formatted_message)
  .then(() => console.log("ok"))
  .catch(err => console.error(err));

Examples of messages

You can find examples of sent and received messages at Broid-Schemas.

Contributing to Broid

See CONTRIBUTE.md

Copyright & License

Copyright (c) 2016-2017 Broid.ai

This project is licensed under the AGPL 3, which can be found here.

Install

npm i @broid/gitter

DownloadsWeekly Downloads

1

Version

2.2.0

License

AGPL-3.0+

Last publish

Collaborators

  • avatar
  • avatar
  • avatar