RocketChat/rocketchat-node

Name: rocketchat-node

Owner: Rocket.Chat

Description: rocket-chat node api

Forked from: qeesung/rocketchat-node

Created: 2016-12-27 03:11:09.0

Updated: 2016-12-27 03:11:11.0

Pushed: 2016-11-18 06:49:09.0

Homepage: null

Size: 19

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

JavaScript RocketChat API for node.js

A node.js module, which provides an object oriented wrapper for the RocketChat REST API.

RocketChat official website address can be found here . RocketChat REST API document can be found here.

This Lib library package the following functions:

• create client
• login
• logout
• get list of public rooms
• join a room
• leave a room
• creating a room
• get all unread messages in a room
• sending a message

Installation

Install with the node package manager npm:

m install rocketchat

or

Install via git clone:

t clone https://github.com/qeesung/rocketchat-node.git
 rocketchat-node
m install

Examples

Create the rocket-chat client

RocketChatApi = require('rocketchat').RocketChatApi;
rocketChatApi = new RocketChatApi('http', config.host, config.port, config.user, config.password);

Obtaining the running rocket-chat version

etChatApi.version(function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Login rocket-chat

etChatApi.login(function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

You don't have to log in every time, and automatically log on when you call the other interface.

Logoff rocket-chat

etChatApi.logout(function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Get list of public rooms

etChatApi.getPublicRooms(function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Join a room

etChatApi.joinRoom(roomID ,function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Leave a room

etChatApi.getUnreadMsg(roomID ,function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Create a room

etChatApi.createRoom(roomName ,function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Get all unread messages in a room

etChatApi.leaveRoom(roomID ,function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

Sending a message

etChatApi.sendMsg(roomID, message, function(err,body){
if(err)
    console.log(err);
else
    console.log(body);

More information can be found by checking RocektChat REST API

Options

RocketChatApi Options:

• protocol<string>: Typically 'http:' or 'https:'
• host<string>: The hostname for your jira server
• port<int>: The port your jira server is listening on (probably 80 or 443)
• username<string>: The username to log in with
• password<string>: Keep it secret, keep it safe

Implemented APIs

• Authentication
• HTTP
• OAuth(comming soon)
• Room
• get public rooms
• join a room
• leave a room
• Messages
• get unread messages from a room
• send messages to a room

TODO

• achieved OAuth authentication mode
• Add SSL security mode