com.semot.wpimapi

类 CommunityAdminAction

java.lang.Object

com.semot.wpimapi.CommunityAdminAction

public class CommunityAdminAction
extends java.lang.Object

伟鹏即时通讯接口-群组功能处理类. 实现群组相关功能，如：创建，读取料，修改，删除等功能。

版本:

1.0

作者:

伟鹏科技-专业即时通讯定制开发 www.semot.com

构造器概要

构造器

构造器和说明
CommunityAdminAction(WpimApiConfig config) 管理功能处理类构造函数.

方法概要

方法

限定符和类型	方法和说明
org.json.JSONObject	addMember(int communityId, int uin) 添加群组成员
org.json.JSONObject	create(org.json.JSONObject data) 创建群组
org.json.JSONObject	delete(int communityId) 删除群组(数据库中删除群，不可恢复,会踢出已有的群用户)
org.json.JSONObject	dissolve(int communityId) 解散群(逻辑删除,仅在数据库做删除标记,会踢出已有的群用户)
org.json.JSONObject	getMembers(int communityId) 获取群组成员
org.json.JSONObject	kickMember(int communityId, int uin) 踢成员出群组
org.json.JSONObject	read(int communityId) 读取群组资料
org.json.JSONObject	readMsgRecord(org.json.JSONObject filter) 读取群组消息记录
org.json.JSONObject	readMsgRecord(org.json.JSONObject filter, java.lang.String fields, java.lang.String order, int pageSize, int pageIndex) 读取群消息
org.json.JSONObject	sendMessage(int communityId, int fromUin, java.lang.String message) 发送群消息,以某一成员的身份发送群消息
org.json.JSONObject	update(org.json.JSONObject data) 修改群组信息

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CommunityAdminAction

public CommunityAdminAction(WpimApiConfig config)

管理功能处理类构造函数. 实现IM管理方面的功能。

参数:

config - 即时通接口配置

方法详细资料

read

public org.json.JSONObject read(int communityId)

读取群组资料

参数:

communityId - 群组ID

返回:

操作返回数据

create

public org.json.JSONObject create(org.json.JSONObject data)

创建群组

参数:

data - 群组JSON数据

返回:

操作返回数据

update

public org.json.JSONObject update(org.json.JSONObject data)

修改群组信息

参数:

data - 群组JSON数据(未提交的字段则不修改)

返回:

操作返回数据

dissolve

public org.json.JSONObject dissolve(int communityId)

解散群(逻辑删除,仅在数据库做删除标记,会踢出已有的群用户)

参数:

communityId - 群组ID

返回:

操作返回数据

delete

public org.json.JSONObject delete(int communityId)

删除群组(数据库中删除群，不可恢复,会踢出已有的群用户)

参数:

communityId - 删除群组

返回:

操作返回数据

getMembers

public org.json.JSONObject getMembers(int communityId)

获取群组成员

参数:

communityId - 群组ID

返回:

操作返回数据

addMember

public org.json.JSONObject addMember(int communityId,
                            int uin)

添加群组成员

参数:

communityId - 群组ID

uin - 即时通号码

返回:

操作返回数据

kickMember

public org.json.JSONObject kickMember(int communityId,
                             int uin)

踢成员出群组

参数:

communityId - 群组ID

uin - 即时通号码

返回:

操作返回数据

sendMessage

public org.json.JSONObject sendMessage(int communityId,
                              int fromUin,
                              java.lang.String message)

发送群消息,以某一成员的身份发送群消息

参数:

communityId - 群组ID

fromUin - 发送者即时通号码

message - 消息内容

返回:

操作返回数据

readMsgRecord

public org.json.JSONObject readMsgRecord(org.json.JSONObject filter)

读取群组消息记录

参数:

filter - 查询过滤

返回:

操作返回数据

readMsgRecord

public org.json.JSONObject readMsgRecord(org.json.JSONObject filter,
                                java.lang.String fields,
                                java.lang.String order,
                                int pageSize,
                                int pageIndex)

读取群消息

参数:

filter - 查询过滤

fields - 所需字段

order - 排序

pageSize - 页面大小(每页记录数)

pageIndex - 页数(当前页)

返回:

操作返回数据