h777arsh/pusher-chatkit-server-java

Pusher chatkit java server SDK

Pusher Chatkit JAVA Server SDK

Find out more about Chatkit here.

Find out the details documentation for this library here.

Installation

Place the jar file from dist folder to your project lib folder.

OR

mvn package

Chatkit Instance

Go to your pusher chatkit dashboard and find your instance_locator and key and use it to create Chatkit instance

Map<String, String> options = new HashMap<>();
options.put("instanceLocator", "YOUR_INSTANCE_LOCATOR");
options.put("key", "YOUR_KEY");

//value in seconds, this is optional, default value is (24 * 60 * 60) seconds means 24 hours
options.put("expireIn", 3600);
ChatKit chatKit = new ChatKit(options);

Authentication

To authenticate a user (a Chatkit client) or you can say AWT token, use the authenticate function.

String userId = "someuser"; //the existing user at chatkit
ApiResponse responseBody = new ApiResponse();
try {
    responseBody = chatKit.authenticate(userId);
}catch(Exception e){
    System.out.println(e.getMessage());
}

//just check the response
System.out.println(responseBody.toString());

Get, Create and Update user

To create a user you must provide an id and a name. You can optionally provide an avatar_url (String) and custom_data (Map<String,String>).

String userId = "someuser"; 
Map<String, Object> data = new HashMap<>();
Map<String, String> customData = new HashMap<>();
customData.put("email", "someuser@example.com");

data.put("name", "Some User");
data.put("avatar_url", "avatar url");
data.put("custom_data", customData);

try{
    ApiResponse apiResponse = chatKit.getUser(userId); //check user already created
    if(apiResponse.getStatus() == 404){
        chatKit.createUser(userId, data);
    }else{
        chatKit.updateUser(userId, data);
    }
}catch(Exception e){
    System.out.println(e.getMessage());
}

Delete user

To delete user you just need to provide user ID.

String userId = "someuser"; 

try{
    ApiResponse apiResponse = chatKit.deleteUser(userId);
}catch(Exception e){
    System.out.println(e.getMessage());
}

Create Room

To create a room you must provide the ID of the user that is creating the room.

String createrId = "someuser"; 
Map<String, Object> data = new HashMap<>();
List<String> userIds = new ArrayList<>();
userIds.add("seth");
userIds.add("ritesh");

data.put("name", "Room Name"); //optional
data.put("private", false); //optional
data.put("user_ids", userIds); //optional

try{
    chatKit.createRoom(createrId, data);
}catch(Exception e){
    System.out.println(e.getMessage());
}

Get User Rooms (Joinable and joined)

To get a room you must provide the ID.

String userId = "someuser"; 

//Get joinable rooms (means user can join)
try{
    ApiResponse apiResponse = chatKit.getUserJoinableRooms(userId);
}catch(Exception e){
    System.out.println(e.getMessage());
}

//Get user rooms 
try{
    ApiResponse apiResponse = chatKit.getUserRooms(userId);
}catch(Exception e){
    System.out.println(e.getMessage());
}