2.2.0 • Published 7 years ago

@broid/discord v2.2.0

Weekly downloads
1
License
AGPL-3.0+
Repository
github
Last release
7 years ago

npm node deps tests bithound bithoundscore nsp-checked

Broid Discord 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

SimpleImageVideoButtonsLocationPhone number

Buttons, Location, Phone number are platform limitations.

Getting started

Register your app/bot on Discord

Install

npm install --save @broid/discord

Connect to Discord

const BroidDiscord = require('@broid/discord');

const discord = new BroidDiscord({ token: "xoxp-xxxxxx" });

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

Parameters

nameTypedefaultDescription
tokenstringYour bot access token
serviceIDstringrandomArbitrary identifier of the running instance
logLevelstringinfoCan be : fatal, error, warn, info, debug, trace

Receive a message

discord.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": "discord"
  },
  "object": {
    "type": "Note",
    "content": "hello world"
  },
  "to": {
    "type": "Person",
    "id": "152486124831181614"
  }
};

discord.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.