Giter Site home page Giter Site logo

rocket.chat.spring.sdk's Introduction

RocketChat SpringBoot SDK

RocketChat Java SDK based on SpringBoot and Reactor (https://projectreactor.io). The SDK is mostly suitable for building chatbots and other integrations with RocketChat using SpringBoot stack.

Getting Started

The SDK contains SpringBoot auto-configuration class that by default creates all available clients.

The following properties must be set:

  • rocketchat.base-url - the base URL for the RocketChat server (ex. http://localhost:3000)
  • rocketchat.user - the bot user name
  • rocketchat.password - the bot user password

Auto-Configured Beans

  • RealtimeClient - the websocket-based Realtime-API client
  • ReactiveRocketChatClient - reactive REST API client
  • RocketChatClient - blocking REST API client

Realtime API

https://rocket.chat/docs/developer-guides/realtime-api/ The Realtime API based on Websocket and offers bi-directional exchange of messages between client and the server.

Logging

In order to get websocket protocol logs set the following property in application.properties file

logging.level.rocketchat.spring.ws.socket.ReactiveWebSocket=debug

REST API

https://rocket.chat/docs/developer-guides/rest-api/

TODO

  • Better websocket reconnect implementation
  • Integration tests suite
  • Add examples
  • dedicated debug logger for rest api network layer

rocket.chat.spring.sdk's People

Contributors

dependabot[bot] avatar mrmaus avatar verusss avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

rocket.chat.spring.sdk's Issues

sended messages not appear in chat window

Hi!
Pretty sure it's not a issue of SDK itselft, but i'm facing strange behavior using package. When i'm sending message to room via client.sendMessage it causes pop-up notify, containing message, can be found if search dialog of chat window but now visible in chat windows itself. Message can't be found either web or local client. But visible in mobile client.
I've installed latest version Rocketchat server locally and faced the same problem. I think it's not problem of SDK and maybe some bug in web and local clients, but maybe you know something about this strange behaviour?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.