com.hn.im.easemob.api.ChatRoomAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hntool Show documentation
There is a newer version: 1.0.18
package com.hn.im.easemob.api;

import com.hn.im.easemob.comm.body.ModifyChatRoomBody;

/**
 * This interface is created for RestAPI of Chat Room, it should be synchronized
 * with the API list.
 * http://docs.easemob.com/doku.php?id=start:100serverintegration:
 * @author Eric23 2016-01-05
 */
public interface ChatRoomAPI {
	/**
	 * 创建聊天室 

	 * POST
	 * 
	 * @param payload
	 *            {name":"testchatroom","description":"server create chatroom","maxusers":300,"owner":"jma1","members":["jma2","jma3"]}
	 * @return Object
	 */
	Object createChatRoom(Object payload);

	/**
	 * 修改聊天室信息 

	 * PUT
	 * 
	 * @param roomId 聊天室标识
	 *
	 * @param payload 消息体 {@link ModifyChatRoomBody}
	 *
	 * @return Object
	 */
	Object modifyChatRoom(String roomId, Object payload);

	/**
	 * 删除聊天室 

	 * DELETE
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @return Object
	 */
	Object deleteChatRoom(String roomId);

	/**
	 * 获取app中所有的聊天室 

	 * GET
	 * 
	 * @return Object
	 */
	Object getAllChatRooms();

	/**
	 * 获取一个聊天室详情 

	 * GET
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @return Object
	 */
	Object getChatRoomDetail(String roomId);

	/**
	 * 聊天室成员添加[单个] 

	 * POST
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @param userName
	 *            用户ID或用户名
	 * @return Object
	 */
	Object addSingleUserToChatRoom(String roomId, String userName);

	/**
	 * 聊天室成员添加[批量] 

	 * POST
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @param payload
	 *            用户ID或用户名，数组形式
	 * @return Object
	 */
	Object addBatchUsersToChatRoom(String roomId, Object payload);

	/**
	 * 聊天室成员删除[单个] 

	 * DELETE
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @param userName
	 *            用户ID或用户名
	 * @return Object
	 */
	Object removeSingleUserFromChatRoom(String roomId, String userName);

	/**
	 * 聊天室成员删除[批量] 

	 * DELETE
	 * 
	 * @param roomId
	 *            聊天室标识
	 * @param userNames
	 *            用户ID或用户名，数组形式
	 * @return Object
	 */
	Object removeBatchUsersFromChatRoom(String roomId, String[] userNames);
}