Skip to content

Latest commit

 

History

History
132 lines (111 loc) · 3.63 KB

README.md

File metadata and controls

132 lines (111 loc) · 3.63 KB
Raw

Build Status

hipchat-java

Java client for the HipChat V2 API. The implementation is base on this doc.

Requirements:

Java 8

Quick Start:

To add this client into your project:

  • maven
<dependency>
    <groupId>io.evanwong.oss</groupId>
    <artifactId>hipchat-java</artifactId>
    <version>0.4.1</version>
</dependency>
  • gradle
compile 'io.evanwong.oss:hipchat-java:0.4.1'

If you are using Java 7, there is a temporary workaround using retrolambda.

  • maven
<dependency>
    <groupId>io.evanwong.oss</groupId>
    <artifactId>hipchat-java7</artifactId>
    <version>0.4.0</version>
</dependency>
  • gradle
compile 'io.evanwong.oss:hipchat-java7:0.4.0'

To send a notification

String defaultAccessToken = "abcd1234";
HipChatClient client = new HipChatClient(defaultAccessToken);
SendRoomNotificationRequestBuilder builder = client.prepareSendRoomNotificationRequestBuilder("myRoom", "hello world!");
Future<NoContent> future = builder.setColor(MessageColor.YELLOW).setNotify(true).build().execute();
//optional... if you want/need to inspect the result:
NoContent noContent = future.get();

Methods

CAPABILITIES
  • Get capabilities
EMOTICONS
  • Get emoticon
  • Get all emoticons
OAUTH SESSIONS
  • Generate token
  • Get session
  • Delete session
ROOMS
  • Get all rooms
  • Create room
  • Get room
  • Update room
  • Delete room
  • View room history
  • Get room message
  • Send room message
  • View recent room history
  • Invite user
  • Add member
  • Remove member
  • Get all members
  • Send room notification redirect
  • Send room notification
  • Get all participants
  • Reply to message
  • Share file with room
  • Share link with room
  • Get room statistics
  • Set topic
  • Get all webhooks
  • Create webhook
  • Get webhook
  • Delete webhook
USERS
  • Get all users
  • Create user
  • View user
  • Update user
  • Delete user
  • Get privatechat message
  • View recent privatechat history
  • Private message user
  • Update photo
  • Delete photo
  • Get auto join rooms
  • Share file with user
  • Share link with user

License

The MIT License (MIT)

Copyright (c) 2014 Evan Wong

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.