差别

这里会显示出您选择的修订版和当前版本之间的差别。

--- im:web:draft:group [2019/03/11 06:53]
jk 创建
+++ im:web:draft:group [2019/03/22 12:52]
jk 移除
@@ 行 1: / 行 1: @@
-====== 群组管理 ======
+====== 群组 ======
-<WRAP round tip>
+环信 Web IM SDK 支持群组功能的集成，集成后可以进行如下操作：
+  * 群组管理
+  * 群成员管理
+  * 加群处理
+  * 禁言管理
+  * 黑名单管理
+  * 群消息管理
+通过这些操作，可以组合帮助您完成多种场景下的 IM 需求。
 **注意：**
-从Web SDK V1.4.11开始，群组管理的接口都已更新了Rest版本，V1.4.10 (包括V1.4.10)以下版本仍然保留XMPP版本，如果需要继续使用XMPP版本的接口，请参考[[im:400webimintegration:40groupchat|群组管理]]
+从 Web SDK V1.4.11 开始，群组管理的接口都已更新了 Rest 版本，V1.4.10 (包括V1.4.10)以下版本仍然保留 XMPP 版本，如果需要继续使用XMPP 版本的接口，请参考[[im:400webimintegration:40groupchat|群组管理]]
-</WRAP>
 ----
+===== 群组管理 =====
+群组管理包含以下处理操作：
+  * 获取用户加入的群组列表
+  * 分页获取公开群
+  * 创建群组
+  * 获取群组信息
+  * 修改群组信息
+  * 解散群组
+  * 退出群组
-===== 获取用户加入的群组列表 =====
+所有处理操作的示例下面会一一说明。
+==== 获取用户加入的群组列表 ====
-调用getGroup函数获取当前登录用户加入的群组列表，示例如下：
+调用''getGroup''函数获取当前登录用户加入的群组列表，示例如下：
 <code javascript>
@@ 行 21: / 行 52: @@
 </code>
-===== 查询群组成员 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#getGroup|getGroup]]
-调用listGroupMember函数分页获取当前群组的所有成员，其中pageSize表示预期每页获取的记录数，pageNum表示页码，示例如下：
+----
-<code javascript>
-var pageNum = 1,
-    pageSize = 1000;
-    var options = {
-        pageNum: pageNum,
-        pageSize: pageSize,
-        groupId: 'yourGroupId',
-        success: function (resp) { console.log("Response: ", resp)},
-        error: function(e){}
-    };
-conn.listGroupMember(options);
-</code>
-===== 获取群组黑名单 =====
+==== 分页获取公开群 ====
+调用''listGroups''函数分页获取当前登录用户加入的群组列表，示例如下：
 <code javascript>
-// 获取群组黑名单
+var limit = 20,
-var getGroupBlackList = function () {
+    cursor = globalCursor;
-    var option = {
+    var options = {
-        roomId: '1480758709661',
+        limit: limit,                                            // 预期每页获取的记录数
-        success: function (list) {
+        cursor: cursor,                                          // 游标
-            console.log('Get group black list: ', list);
+        success: function (resp) {
+            console.log("Response: ", resp);
+            globalCursor = resp.cursor;
         },
-        error: function () {
+        error: function (e) {}
-            console.log('Get group black list error.');
-        }
     };
-    conn.getGroupBlacklist(option);
+conn.listGroups(options);
-};
 </code>
+**注意：**
+  * 如果数据还有下一页，API 返回值会包含此字段，传递此字段可获取下一页的数据，默认为''null''，为''null''时获取第一页数据
-===== 创建群组 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#listGroups|listGroups]]
-调用createGroupNew函数创建群组，groupname表示群组名，desc表示群组描述，members是用户名组成的数组，pub等于true时，创建为公开群，approval等于true时，加群需要审批，为false时加群无需审批。另外，创建群组成功后会在回调函数里调用onCreateGroup函数。
+----
+==== 创建群组 ====
+调用''createGroupNew''函数创建群组，示例代码如下
 <code javascript>
 var options = {
             data: {
-                groupname: value,
+                groupname: value,                    // 群组名
-                desc: info,
+                desc: info,                          // 群组描述
-                members: friendsSelected,
+                members: friendsSelected,            // 用户名组成的数组
-                public: pub,
+                public: pub,                         // pub等于true时，创建为公开群
-                approval: approval,
+                approval: approval,                  // approval为true，加群需审批，为false时加群无需审批
                 allowinvites: allowInvites
             },
@@ 行 75: / 行 103: @@
 conn.createGroupNew(options);
 </code>
-===== 获取群组信息 =====
-调用getGroupInfo根据群id获取群组详情，groupId为群id，示例如下：
+**注意：**
+  * 创建群组成功后会在回调函数里调用''onCreateGroup''函数
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#createGroupNew|createGroupNew]]
+----
+==== 获取群组信息 ====
+调用''getGroupInfo''根据群 id 获取群组详情，示例如下：
 <code javascript>
 var options = {
-    groupId: gid,
+    groupId: gid,                                //群组id
     success: function(resp){
         console.log("Response: ", resp);
@@ 行 88: / 行 127: @@
 </code>
-===== 修改群组信息 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#getGroupInfo|getGroupInfo]]
+----
-只有群组的管理员可以修改群组名称和群组简介，示例如下。
+==== 修改群组信息 ====
-注意：在获取群组时候就可以获取群管理员的ID，从而前端可决定是否显示修改信息按钮。
+只有群组的管理员可以修改群组名称和群组简介，调用''changeGroupSubject''修改群组信息，示例如下：
 <code javascript>
@@ 行 99: / 行 142: @@
     var option = {
         roomId: '1480756943693',
-        subject: 'ChangeTest',    // 群组名称
+        subject: 'ChangeTest',                         // 群组名称
         description: 'Change group information test',  // 群组简介
         success: function () {
@@ 行 109: / 行 152: @@
 </code>
-===== 将好友加入群组 =====
+**注意：**
+  * 在获取群组时候就可以获取群管理员的 ID ，从而前端可决定是否显示修改信息按钮。
-管理员可以将好友加入群组。
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#changeGroupSubject|changeGroupSubject]]
+----
+==== 解散群组 ====
+  * 只有群组的管理员有权限将成员踢出群组；
+  * 群组解散后，所有群成员均退出该群。
+示例如下：
 <code javascript>
-// 加好友入群
+// 解散一个群组
-var addGroupMembers = function () {
+var dissolveGroup = function () {
     var option = {
-        list: ['asdfghj', 'wjy6'],
+        groupId: '1480840256052',
-        roomId: '1480841456167'
+        success: function () {
+            console.log('Destroy group success!');
+        }
     };
-    conn.addGroupMembers(option);
+    conn.dissolveGroup(option);
 };
 </code>
+**注意：**
+  * 在获取群组时候就可以获取群管理员的ID，从而前端可决定是否显示解散按钮。
-===== 将成员禁言 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#dissolveGroup|dissolveGroup]]
-调用mute将成员禁言，username表示成员用户名，muteDuration表示将要被禁言的时长，单位是毫秒，示例如下：
+----
+==== 退出群组 ====
+群成员可以主动退出群组，调用''leaveGroupBySelf''退出群组，示例如下：
 <code javascript>
-var options = {
+// 成员主动退出群
-        username: "user",
+var leaveGroup = function () {
-        muteDuration: 886400000,
+    var option = {
-        groupId: "groupId",
+        to: 'asdfghj',
-        success: function (resp) {},
+        roomId: '1480747027186',
-        error: function(e){}
+        success: function () {
+            console.log('You leave room succeed!');
+        },
+        error: function () {
+            console.log('Leave room faild');
+        }
     };
-conn.mute(options);
+    conn.leaveGroupBySelf(option);
+};
 </code>
-===== 将成员解除禁言 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#leaveGroupBySelf|leaveGroupBySelf]]
-调用removeMute将成员禁言，username表示成员用户名，groupId表示群组id，示例如下：
+----
+===== 群成员管理 =====
+群成员管理包含以下处理操作：
+  * 查询群组成员
+  * 将成员设为管理员
+  * 将管理员撤销
+  * 获取群组下所有管理员
+所有处理操作的示例下面会一一说明。
+==== 查询群组成员 ====
+调用''listGroupMember''函数分页获取当前群组的所有成员，示例如下：
 <code javascript>
-var options = {
+var pageNum = 1,
-        groupId: "groupId",
+    pageSize = 1000;
-        username: "user",
+    var options = {
-        success: function(resp){},
+        pageNum: pageNum,                                               // 页码
-        error: function (e) {}
+        pageSize: pageSize,                                             // 预期每页获取的记录数
+        groupId: 'yourGroupId',
+        success: function (resp) { console.log("Response: ", resp)},
+        error: function(e){}
     };
-conn.removeMute(options);
+conn.listGroupMember(options);
 </code>
-===== 获取群组下所有被禁言成员 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#listGroupMember|listGroupMember]]
-调用getMuted将成员禁言，groupId表示群组id，示例如下：
+----
-<code javascript>
+==== 将成员设为管理员 ====
-var options = {
-            groupId: "groupId",
-            success: function (resp) {},
-            error: function(e){}
-        };
-conn.getMuted(options);
-</code>
-===== 将成员设为群管理员 =====
-调用setAdmin将成员禁言，groupId表示群组id，user表示用户名，示例如下：
+调用''setAdmin''将成员禁言，示例如下：
 <code javascript>
 var options = {
-        groupId: "groupId",
+        groupId: "groupId",            // 群组id
-        username: "user",
+        username: "user",              // 用户名
         success: function(resp) {},
         error: function(e){}
@@ 行 180: / 行 261: @@
 </code>
-===== 将管理员撤销 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#setAdmin|setAdmin]]
-调用removeAdmin将成员禁言，groupId表示群组id，user表示用户名，示例如下：
+----
+==== 将管理员撤销 ====
+调用''removeAdmin''将成员禁言，示例如下：
 <code javascript>
 var options = {
-        groupId: "groupId",
+        groupId: "groupId",             // 群组id
-        username: "user",
+        username: "user",               // 用户名
         success: function(resp) {},
         error: function (e) {}
@@ 行 194: / 行 281: @@
 </code>
-===== 获取群组下所有管理员 =====
-调用getGroupAdmin获取群组下所有管理员，groupId表示群组id，示例如下：
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#removeAdmin|removeAdmin]]
+----
+==== 获取群组所有管理员 ====
+调用''getGroupAdmin''获取群组下所有管理员，示例如下：
 <code javascript>
 var options = {
-        groupId: "groupId",
+        groupId: "groupId",                 // 群组id
         success: function (resp) {},
         error: function(e){}
@@ 行 207: / 行 301: @@
 </code>
-===== 将成员加入群黑名单(单个) =====
-调用groupBlockSingle将单个成员加入群组黑名单，groupId表示群组id，username表示将要被加入黑名单的用户名，示例如下：
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#getGroupAdmin|getGroupAdmin]]
+----
+===== 加群处理 =====
+加群包含以下处理操作：
+  * 将好友加入群组
+  * 向群组发出入群申请
+  * 同意用户加入群
+  * 拒绝用户加入群
+所有处理操作的示例下面会一一说明。
+==== 将好友加入群组 ====
+管理员可以将好友加入群组。调用''addGroupMembers''将好友加入群组，示例如下：
 <code javascript>
-var options = {
+// 加好友入群
-        groupId: Demo.selected,
+var addGroupMembers = function () {
-        username: username,
+    var option = {
-        success: function (resp) {
+        list: ['asdfghj', 'wjy6'],
-            console.log("Response: ", resp);
+        roomId: '1480841456167'
-        },
-        error: function(e){}
     };
-conn.groupBlockSingle(options);
+    conn.addGroupMembers(option);
+};
 </code>
-===== 将成员加入群黑名单(批量) =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#addGroupMembers|addGroupMembers]]
-调用groupBlockMulti将成员批量加入群组黑名单，groupId表示群组id，username表示将要被加入黑名单的用户名数组，示例如下：
+----
+==== 向群组发出入群申请 ====
+调用''joinGroup''向群组发出入群申请，示例如下：
 <code javascript>
 var options = {
-        groupId: 'Your groupId',
+        groupId: "groupId",                              // 群组ID
-        username: ['user1', 'user2', ...users],
+        success: function(resp) {
-        success: function (resp) {
             console.log("Response: ", resp);
         },
-        error: function(e){}
+        error: function(e) {
+            if(e.type == 17){
+                console.log("您已经在这个群组里了");
+            }
+        }
     };
-conn.groupBlockMulti(options);
+conn.joinGroup(options);
 </code>
-===== 将成员移出群组黑名单（单个） =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#joinGroup|joinGroup]]
-调用removeGroupBlockSingle将单个成员从群组黑名单中移除，groupId是群组id，username是需要移除的用户名。
+----
+==== 同意用户加入群 ====
+调用''agreeJoinGroup''同意用户加群请求，示例如下：
 <code javascript>
 var options = {
-        groupId: "Your Group ID",
+        applicant: applicant,                          // 申请加群的用户名
-        username: "user",
+        groupId: groupId,                              // 群组ID
         success: function(resp){
-            console.log("Response: ", resp);
+            console.log(resp);
         },
-        error: function(e) {};
+        error: function(e){}
-    }
+    };
-conn.removeGroupBlockSingle(options);
+conn.agreeJoinGroup(options);
 </code>
-===== 将成员移出群组黑名单（批量） =====
-调用removeGroupBlockMulti将成员批量从群组黑名单中移除，groupId是群组id，username是需要移除的用户名数组。
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#agreeJoinGroup|agreeJoinGroup]]
+----
+==== 同意用户加入群 ====
+调用''rejectJoinGroup''拒绝用户加群请求，示例如下：
 <code javascript>
 var options = {
-        groupId: "Your Group ID",
+        applicant: applicant,                // 申请加群的用户名
-        username: ["user1", "user2"],
+        groupId: groupId,                    // 群组ID
         success: function(resp){
-            console.log("Response: ", resp);
+            console.log(resp);
         },
-        error: function(e) {};
+        error: function(e){}
-    }
+    };
-conn.removeGroupBlockMulti(options);
+conn.rejectJoinGroup(options);
 </code>
-===== 解散群组 =====
-只有群组的管理员有权限将成员踢出群组。群组解散后，所有群成员均退出该群。
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#rejectJoinGroup|rejectJoinGroup]]
-注意：在获取群组时候就可以获取群管理员的ID，从而前端可决定是否显示解散按钮。
+----
+===== 禁言管理 =====
+禁言管理包含以下处理操作：
+  * 将成员禁言
+  * 将成员解除禁言
+  * 获取群组下禁言成员
+所有处理操作的示例下面会一一说明。
+==== 将成员禁言 ====
+调用''mute''将成员禁言，示例如下：
 <code javascript>
-// 解散一个群组
+var options = {
-var dissolveGroup = function () {
+        username: "user",                      // 成员用户名
-    var option = {
+        muteDuration: 886400000,               // 禁言的时长，单位是毫秒
-        groupId: '1480840256052',
+        groupId: "groupId",
-        success: function () {
+        success: function (resp) {},
-            console.log('Destroy group success!');
+        error: function(e){}
-        }
     };
-    conn.dissolveGroup(option);
+conn.mute(options);
-};
 </code>
-===== 退出群组 =====
-群成员可以主动退出群组，示例如下。
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#mute|mute]]
+----
+==== 将成员解除禁言 ====
+调用''removeMute''将成员解除禁言，示例如下：
 <code javascript>
-// 成员主动退出群
+var options = {
-var leaveGroup = function () {
+        groupId: "groupId",                  // 群组ID
-    var option = {
+        username: "user",                    // 成员用户名
-        to: 'asdfghj',
+        success: function(resp){},
-        roomId: '1480747027186',
+        error: function (e) {}
-        success: function () {
-            console.log('You leave room succeed!');
-        },
-        error: function () {
-            console.log('Leave room faild');
-        }
     };
-    conn.leaveGroupBySelf(option);
+conn.removeMute(options);
-};
 </code>
-===== 分页获取公开群 =====
-调用listGroups函数分页获取当前登录用户加入的群组列表，其中limit表示预期每页获取的记录数，cursor　游标，如果数据还有下一页，API 返回值会包含此字段，传递此字段可获取下一页的数据，默认为null，为null时获取第一页数据，示例如下：
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#removeMute|removeMute]]
+----
+==== 获取群组下禁言成员 ====
+调用''getMuted''将成员禁言，获取群组下所有被禁言的成员，示例如下：
 <code javascript>
-var limit = 20,
+var options = {
-    cursor = globalCursor;
+            groupId: "groupId",                // 群组ID
-    var options = {
+            success: function (resp) {},
-        limit: limit,
+            error: function(e){}
-        cursor: cursor,
+        };
+conn.getMuted(options);
+</code>
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#getMuted|getMuted]]
+----
+===== 黑名单管理 =====
+黑名单管理包含以下处理操作：
+  * 将成员加入群黑名单（单个）
+  * 将成员加入群黑名单（批量）
+  * 将成员移除群组黑名单（单个）
+  * 将成员移除群组黑名单（批量）
+  * 获取群组黑名单
+所有处理操作的示例下面会一一说明。
+==== 将成员加入群黑名单（单个） ====
+调用''groupBlockSingle''将单个成员加入群组黑名单，示例如下：
+<code javascript>
+var options = {
+        groupId: Demo.selected,                     // 群组ID
+        username: username,                         // 将要被加入黑名单的用户名
         success: function (resp) {
             console.log("Response: ", resp);
-            globalCursor = resp.cursor;
         },
-        error: function (e) {}
+        error: function(e){}
     };
-conn.listGroups(options);
+conn.groupBlockSingle(options);
 </code>
-===== 向群组发出入群申请 =====
-调用joinGroup向群组发出入群申请，groupId表示群组的群id，示例如下：
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#groupBlockSingle|groupBlockSingle]]
+----
+==== 将成员加入群黑名单（批量） ====
+调用''groupBlockMulti''将成员批量加入群组黑名单，示例如下：
 <code javascript>
 var options = {
-        groupId: "groupId",
+        groupId: 'Your groupId',                         // 群组ID
-        success: function(resp) {
+        username: ['user1', 'user2', ...users],          // 将要被加入黑名单的用户名数组
+        success: function (resp) {
             console.log("Response: ", resp);
         },
-        error: function(e) {
+        error: function(e){}
-            if(e.type == 17){
-                console.log("您已经在这个群组里了");
-            }
-        }
     };
-conn.joinGroup(options);
+conn.groupBlockMulti(options);
 </code>
-===== 同意用户加入群 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#groupBlockMulti|groupBlockMulti]]
-调用agreeJoinGroup同意用户加群请求，groupId表示群组的群id，applicant为申请加群的用户名，示例如下：
+----
+==== 将成员移除群组黑名单（单个） ====
+调用''removeGroupBlockSingle''将单个成员从群组黑名单中移除，示例如下：
 <code javascript>
 var options = {
-        applicant: applicant,
+        groupId: "Your Group ID",                     // 群组ID
-        groupId: groupId,
+        username: "user",                             // 需要移除的用户名
         success: function(resp){
-            console.log(resp);
+            console.log("Response: ", resp);
         },
-        error: function(e){}
+        error: function(e) {};
-    };
+    }
-conn.agreeJoinGroup(options);
+conn.removeGroupBlockSingle(options);
 </code>
-===== 拒绝用户加入群 =====
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#removeGroupBlockSingle|removeGroupBlockSingle]]
-调用rejectJoinGroup同意用户加群请求，groupId表示群组的群id，applicant为申请加群的用户名，示例如下：
+----
+==== 将成员移除群组黑名单（批量） ====
+调用''removeGroupBlockMulti''将成员批量从群组黑名单中移除，示例如下：
 <code javascript>
 var options = {
-        applicant: applicant,
+        groupId: "Your Group ID",                       // 群组ID
-        groupId: groupId,
+        username: ["user1", "user2"],                   // 需要移除的用户名数组
         success: function(resp){
-            console.log(resp);
+            console.log("Response: ", resp);
         },
-        error: function(e){}
+        error: function(e) {};
+    }
+conn.removeGroupBlockMulti(options);
+</code>
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#removeGroupBlockMulti|removeGroupBlockMulti]]
+----
+==== 获取群组黑名单 ====
+调用''getGroupBlacklist''获取群组黑名单，示例如下：
+<code javascript>
+// 获取群组黑名单
+var getGroupBlackList = function () {
+    var option = {
+        roomId: '1480758709661',
+        success: function (list) {
+            console.log('Get group black list: ', list);
+        },
+        error: function () {
+            console.log('Get group black list error.');
+        }
     };
-conn.rejectJoinGroup(options);
+    conn.getGroupBlacklist(option);
+};
 </code>
-===== 发送消息 =====
-见[[im:400webimintegration:30singlechat#发送消息|发送消息]]。
+=== API ===
+示例中使用到的 API
+  * [[http://webim-h5.easemob.com/jsdoc/out/connection.html#getGroupBlacklist|getGroupBlacklist]]
+----
+===== 群消息 =====
+群消息包含以下处理操作：
+  * 发送消息
+  * 接收及处理消息
+所有处理操作下面会一一说明。
+==== 发送消息 ====
+见[[im:web:basics:message#发送消息|发送消息]]。
+==== 接收及处理消息 ====
+  * 群聊接收及处理消息同单聊;
+  * 消息体与单聊消息根据 message 的 type 进行区分;
+  * 单聊为：chat，群聊为：groupchat，聊天室为：chatroom;
+  * 根据消息的类型进行不同处理即可。
-===== 接收及处理消息 =====
-群聊接收及处理消息同单聊，消息体与单聊消息根据 message 的 type 进行区分，单聊为：chat，群聊为：groupchat，聊天室为：chatroom。根据消息的类型进行不同处理即可。