Skip to content

[DEPRECATED, NOT MAINTAINED] Java/Android SDK for Rocket.Chat

License

Notifications You must be signed in to change notification settings

RocketChat/Rocket.Chat.Java.SDK

Repository files navigation

DEPRECATED

We are working on a new SDK in Kotlin, with compatibility with JAVA (in the future).

Rocket.Chat.Java.SDK

License: MIT RocketChat Gitter chat

  • This SDK is used for handling background communication with server.
  • Contains set of remote procedure calls (RPC) to communicate with server and return appropriate results.
  • It doesn't have any user interface. All API's defined in SDK are asynchronous/non-blocking.

Overview

This SDK is divided into two parts

  1. Core SDK
  • Core SDK intro
  • RocketChat API usage documentation
  • RocketChat room API usage documentation

Download

  1. LiveChat SDK
  • LiveChat SDK intro
  • LiveChat API usage documentation
  • LiveChat room API usage documentation

Download

License

MIT

Gradle

For java

1. Core SDK

dependencies {
    compile 'com.rocketchat.core:rocketchat-core:0.7.1'
}

2. LiveChat SDK

dependencies {
    compile 'com.rocketchat.livechat:rocketchat-livechat:0.7.1'
}

For android

1. Core SDK

dependencies {
    compile ('com.rocketchat.core:rocketchat-core:0.7.1'){
        exclude group :'org.json', module: 'json'
    }
}

2. LiveChat SDK

dependencies {
    compile ('com.rocketchat.livechat:rocketchat-livechat:0.7.1'){
            exclude group :'org.json', module: 'json'
    }
}

Features

1. Core SDK

  • This SDK consist of chat related API's available on the Rocket.Chat server.
  • Currently supports following features.
  1. Login/Resume Login
  2. Getting Permissions/Getting public settings
  3. Getting User Roles
  4. Getting rooms
  5. Getting chat history
  6. Send message to the room
  7. Delete message
  8. Update message
  9. Pin message
  10. Unpin message
  11. Star message
  12. Create public group
  13. Create private group
  14. Delete group
  15. Archive room
  16. Unarchive room
  17. Join public group
  18. Leave group
  19. Open room
  20. Hide room
  21. Set favourite room
  22. Set status (ONLINE, OFFLINE, BUSY, AWAY)
  23. Getting room roles
  24. Upload files
  25. Getting status of other users in realtime (Register for user status by userId)
  26. Logout
  • User documentation can be found here => Core SDK

2. LiveChat SDK

  • This SDK refers to providing helpDesk feature (LiveChat )in any JVM platform.
  • This currently supports following features.
  1. Getting LiveChat configuration data from server
  2. Registration
  3. Login
  4. Choose departments
  5. Getting Chat history
  6. Getting Agent data
  7. Send message
  8. Subscribe room
  9. Close conversation

Important Note

All docs are available under docs/ directory on the repo.

Demo Android App