groupManage#
groupManage#
群管理
- groupManage
- .asyncGetGroupInfo(group_id, froce) ⇒
Promise.<GroupInfoAndSettings> - .asyncGetJoinedGroups(froce) ⇒
Promise.<Array.<number>> - .openGroup(group_id)
- .getAllGroupDetail() ⇒
Object.<number, module:types~GroupInfoAndSettings> - .asyncGetGroupMembers(group_id) ⇒
Promise.<Array.<number>> - .getGroupMembers(group_id) ⇒
Array.<GroupMember> - .asyncGetGroupListDetail(gids) ⇒
Promise.<Array.<module:types~BriefGroupInfoAndSettings>> - .getGruopMessage(gid) ⇒
Array.<Meta> - .asyncGetInfo(params) ⇒
Promise.<GroupInfoAndSettings> - .asyncGetMemberList(param) ⇒
Promise.<Array.<module:types~GroupMember>> - .readGroupMessage(group_id, mid)
- .recallMessage(uid, mid)
- .appendMessageContent(uid, mid, content)
- .replaceMessage(uid, mid, content, config, ext)
- .getUnreadCount(gid) ⇒
number - .asyncGetAdminList(params) ⇒
Promise.<Array.<module:types~GroupMember>> - .asyncAdminAdd(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncAdminRemove(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncGetAnouncementById(params) ⇒
Promise.<GroupAnnouncement> - .asyncAnouncementDelete(params) ⇒
Promise.<boolean> - .asyncAnnouncementEdit(params) ⇒
Promise.<GroupAnnouncement> - .asyncGetAnnouncementList(params) ⇒
Promise.<Array.<module:types~GroupAnnouncement>> - .asyncCreate(params) ⇒
Promise.<GroupInfoAndSettings> - .asyncDestroy(params) ⇒
Promise.<boolean> - .asyncUpdateAvatar(params) ⇒
Promise.<boolean> - .asyncUpdateDescription(params) ⇒
Promise.<boolean> - .asyncUpdateExt(params) ⇒
Promise.<boolean> - .asyncUpdateName(params) ⇒
Promise.<boolean> - .asyncGroupMsgMutemode(params) ⇒
Promise.<boolean> - .asyncGroupBannedList(params) ⇒
Promise.<Array.<module:types~GroupMemberBanned>> - .asyncGroupBab(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncGroupUnban(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncGetSettings(group_id) ⇒
Promise.<GroupInfoAndSettings> - .asyncUpdateAllowMemberInvitation(params) ⇒
Promise.<boolean> - .asyncUpdateAllowMemberModify(params) ⇒
Promise.<boolean> - .asyncUpdateEnableReadack(params) ⇒
Promise.<boolean> - .asyncUpdateHistoryVisible(params) ⇒
Promise.<boolean> - .asyncUpdateRequireadminapproval(params) ⇒
Promise.<boolean> - .asyncBanAll(params) ⇒
Promise.<GroupBanAllResponse> - .asyncUnBanAll(params) ⇒
Promise.<boolean> - .asyncOwnerTransfer(params) ⇒
Promise.<GroupUserRelationResponse> - .asyncGetUserJoined(params) ⇒
Promise.<Array.<number>> - .asyncApply(params) ⇒
Promise.<GroupUserRelationResponse> - .asyncApplyHandle(params) ⇒
Promise.<GroupUserRelationResponse> - .asyncGroupBockedlist(params) ⇒
Promise.<Array.<module:types~GroupBlockedListItem>> - .asyncGroupBlock(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncGroupUnblock(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncKick(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncGetInvitationList() ⇒
Promise.<Array.<module:types~GroupInvitation>> - .asyncInvite(params) ⇒
Promise.<Array.<module:types~GroupUserRelationResponse>> - .asyncInviteHandle(params) ⇒
Promise.<boolean> - .asyncGetMemberDisplayName(params) ⇒
Promise.<Array.<module:types~GroupMember>> - .asyncLeave(params) ⇒
Promise.<boolean> - .asyncUpdateDisplayName(params) ⇒
Promise.<boolean> - .asncGetApplicationList(params) ⇒
Promise.<Array.<module:types~GroupApplication>> - .asyncGetFileList(params) ⇒
Promise.<Array.<module:types~GroupSharedFile>> - .asyncFileDelete(params) ⇒
Promise.<Array.<module:types~GroupSharedFileResponse>> - .asyncFileUpload(params) ⇒
Promise.<Array.<module:types~GroupSharedFile>>
groupManage.asyncGetGroupInfo(group_id, froce) ⇒ Promise.<GroupInfoAndSettings>#
获取群信息
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - 群信息
| Param | Type | Description |
|---|---|---|
| group_id | number | 群ID |
| froce | boolean | 是否强制从服务器拉取: true - 从服务器拉取, false - 优先从本地存储获取 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetGroupInfo" %}{% endlanying_code_snippet %}
groupManage.asyncGetJoinedGroups(froce) ⇒ Promise.<Array.<number>>#
获取加入的群组
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - 群组ID列表
| Param | Type | Description |
|---|---|---|
| froce | boolean | 是否强制从服务器拉取: true - 从服务器拉取, false - 优先从本地存储获取 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetJoinedGroups" %}{% endlanying_code_snippet %}
groupManage.openGroup(group_id)#
打开群组, 此方法会准备群组聊天界面的一些必备信息。
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="openGroup" %}{% endlanying_code_snippet %}
groupManage.getAllGroupDetail() ⇒ Object.<number, module:types~GroupInfoAndSettings>#
获取缓存的所有群组详情
Kind: static method of groupManage
Returns: Object.<number, module:types~GroupInfoAndSettings> - 群组详情
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="getAllGroupDetail" %}{% endlanying_code_snippet %}
groupManage.asyncGetGroupMembers(group_id) ⇒ Promise.<Array.<number>>#
获取群组成员ID列表(异步)
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - 群成员ID列表
| Param | Type | Description |
|---|---|---|
| group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetGroupMembers" %}{% endlanying_code_snippet %}
groupManage.getGroupMembers(group_id) ⇒ Array.<GroupMember>#
获取群组成员(同步)
Kind: static method of groupManage
Returns: Array.<GroupMember> - 群成员列表
| Param | Type | Description |
|---|---|---|
| group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="getGroupMembers" %}{% endlanying_code_snippet %}
groupManage.asyncGetGroupListDetail(gids) ⇒ Promise.<Array.<module:types~BriefGroupInfoAndSettings>>#
按id获取群组详情
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~BriefGroupInfoAndSettings>> - 群组详情列表
| Param | Type | Description |
|---|---|---|
| gids | Array.<number> | 群组ID列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetGroupListDetail" %}{% endlanying_code_snippet %}
groupManage.getGruopMessage(gid) ⇒ Array.<Meta>#
获取群消息
Kind: static method of groupManage
Returns: Array.<Meta> - 群消息列表
| Param | Type | Description |
|---|---|---|
| gid | number | 群ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="getGruopMessage" %}{% endlanying_code_snippet %}
groupManage.asyncGetInfo(params) ⇒ Promise.<GroupInfoAndSettings>#
获取群组详情
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - 群组详情
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetInfo" %}{% endlanying_code_snippet %}
groupManage.asyncGetMemberList(param) ⇒ Promise.<Array.<module:types~GroupMember>>#
获取群成员列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - 群成员列表
| Param | Type | Description |
|---|---|---|
| param | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetMemberList" %}{% endlanying_code_snippet %}
groupManage.readGroupMessage(group_id, mid)#
将群消息设置已读
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| group_id | number | 群组ID |
| mid | number | 消息ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="readGroupMessage" %}{% endlanying_code_snippet %}
groupManage.recallMessage(uid, mid)#
撤回消息
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| uid | number | 群组ID |
| mid | number | 消息ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="recallMessage" %}{% endlanying_code_snippet %}
groupManage.appendMessageContent(uid, mid, content)#
追加消息内容
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| uid | number | 会话ID |
| mid | number | 消息ID |
| content | string | 消息追加内容 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="appendMessageContent" %}{% endlanying_code_snippet %}
groupManage.replaceMessage(uid, mid, content, config, ext)#
更新消息内容
Kind: static method of groupManage
| Param | Type | Default | Description |
|---|---|---|---|
| uid | number | 会话ID | |
| mid | number | 消息ID | |
| content | string | 消息更新内容 | |
| config | string | object | null | 消息更新配置 |
| ext | string | object | null | 消息更新扩展信息 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="replaceMessage" %}{% endlanying_code_snippet %}
groupManage.getUnreadCount(gid) ⇒ number#
获取群未读消息数
Kind: static method of groupManage
Returns: number - 未读消息数
| Param | Type | Description |
|---|---|---|
| gid | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="getUnreadCount" %}{% endlanying_code_snippet %}
groupManage.asyncGetAdminList(params) ⇒ Promise.<Array.<module:types~GroupMember>>#
获取群管理员列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - 群管理员列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetAdminList" %}{% endlanying_code_snippet %}
groupManage.asyncAdminAdd(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
群添加管理员
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncAdminAdd" %}{% endlanying_code_snippet %}
groupManage.asyncAdminRemove(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
移除管理员
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncAdminRemove" %}{% endlanying_code_snippet %}
groupManage.asyncGetAnouncementById(params) ⇒ Promise.<GroupAnnouncement>#
获取群公告详情
Kind: static method of groupManage
Returns: Promise.<GroupAnnouncement> - 群公告详情
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.announcement_id | Array.<number> | 公告ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetAnouncementById" %}{% endlanying_code_snippet %}
groupManage.asyncAnouncementDelete(params) ⇒ Promise.<boolean>#
删除群公告
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.announcement_id | Array.<number> | 公告ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncAnouncementDelete" %}{% endlanying_code_snippet %}
groupManage.asyncAnnouncementEdit(params) ⇒ Promise.<GroupAnnouncement>#
编辑群公告
Kind: static method of groupManage
Returns: Promise.<GroupAnnouncement> - 群公告详情
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.title | string | 公告标题 |
| params.content | string | 公告内容 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncAnnouncementEdit" %}{% endlanying_code_snippet %}
groupManage.asyncGetAnnouncementList(params) ⇒ Promise.<Array.<module:types~GroupAnnouncement>>#
群公告列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupAnnouncement>> - 群公告详情列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetAnnouncementList" %}{% endlanying_code_snippet %}
groupManage.asyncCreate(params) ⇒ Promise.<GroupInfoAndSettings>#
创建群组
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - 群详情
| Param | Type | Description |
|---|---|---|
| params | GroupInfoRequest | 请求参数 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncCreate" %}{% endlanying_code_snippet %}
groupManage.asyncDestroy(params) ⇒ Promise.<boolean>#
解散群组
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncDestroy" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateAvatar(params) ⇒ Promise.<boolean>#
更新群头像
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | string | 头像地址 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateAvatar" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateDescription(params) ⇒ Promise.<boolean>#
更新群描述
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | string | 群组描述 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateDescription" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateExt(params) ⇒ Promise.<boolean>#
更新群扩展信息
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | string | 扩展信息 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateExt" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateName(params) ⇒ Promise.<boolean>#
更新群名称
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | string | 群名称 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateName" %}{% endlanying_code_snippet %}
groupManage.asyncGroupMsgMutemode(params) ⇒ Promise.<boolean>#
设置群消息免打扰情况
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.msg_mute_mode | number | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息,不接收消息 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupMsgMutemode" %}{% endlanying_code_snippet %}
groupManage.asyncGroupBannedList(params) ⇒ Promise.<Array.<module:types~GroupMemberBanned>>#
获取群禁言列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMemberBanned>> - 禁言成员列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupBannedList" %}{% endlanying_code_snippet %}
groupManage.asyncGroupBab(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
禁言群成员
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 请求结果列表
| Param | Type | Description |
|---|---|---|
| params | GroupBannedMemberRequest | 请求参数 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupBab" %}{% endlanying_code_snippet %}
groupManage.asyncGroupUnban(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
解除成员禁言
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 请求结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupUnban" %}{% endlanying_code_snippet %}
groupManage.asyncGetSettings(group_id) ⇒ Promise.<GroupInfoAndSettings>#
获取群设置
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - 群设置
| Param | Type | Description |
|---|---|---|
| group_id | number | 群ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetSettings" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateAllowMemberInvitation(params) ⇒ Promise.<boolean>#
设置群成员是否可以邀请
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | boolean | 群成员邀请设置: false - 不允许邀请, true - 允许邀请(默认) |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateAllowMemberInvitation" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateAllowMemberModify(params) ⇒ Promise.<boolean>#
设置群成员是否可以修改群信息
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | boolean | 群成员修改群信息设置: false - 群成员不能修改群信息(默认), true - 群成员可以修改群信息 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateAllowMemberModify" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateEnableReadack(params) ⇒ Promise.<boolean>#
设置群是否开启已读模式
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | boolean | 是否开启群消息已读功能: false - 不开启, true - 开启 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateEnableReadack" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateHistoryVisible(params) ⇒ Promise.<boolean>#
设置群历史是否可见
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | boolean | 设置群历史是否可见: false - 不可见, true - 可见 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateHistoryVisible" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateRequireadminapproval(params) ⇒ Promise.<boolean>#
设置入群是否需要申请
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.apply_approval | boolean | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateRequireadminapproval" %}{% endlanying_code_snippet %}
groupManage.asyncBanAll(params) ⇒ Promise.<GroupBanAllResponse>#
全员禁言,只允许管理员发消息
Kind: static method of groupManage
Returns: Promise.<GroupBanAllResponse> - 结果
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.duration | number | 禁言时长,单位为分钟,int64 |
| params.group_id | number | 群id,int64 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncBanAll" %}{% endlanying_code_snippet %}
groupManage.asyncUnBanAll(params) ⇒ Promise.<boolean>#
取消全员禁言
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群id,int64 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUnBanAll" %}{% endlanying_code_snippet %}
groupManage.asyncOwnerTransfer(params) ⇒ Promise.<GroupUserRelationResponse>#
更换群主
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - 结果
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.new_owner | number | 新群主的用户ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncOwnerTransfer" %}{% endlanying_code_snippet %}
groupManage.asyncGetUserJoined(params) ⇒ Promise.<Array.<number>>#
获取用户的群组列表
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - 群ID的列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数, 空对象 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetUserJoined" %}{% endlanying_code_snippet %}
groupManage.asyncApply(params) ⇒ Promise.<GroupUserRelationResponse>#
申请加入群
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - 结果
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.reason | string | 申请入群原因 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncApply" %}{% endlanying_code_snippet %}
groupManage.asyncApplyHandle(params) ⇒ Promise.<GroupUserRelationResponse>#
处理用户的入群申请
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - 结果
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_id | number | 用户ID |
| params.approval | boolean | 审批结果:true为同意,false为拒绝 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncApplyHandle" %}{% endlanying_code_snippet %}
groupManage.asyncGroupBockedlist(params) ⇒ Promise.<Array.<module:types~GroupBlockedListItem>>#
获取群黑名单
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupBlockedListItem>> - 群黑名单列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupBockedlist" %}{% endlanying_code_snippet %}
groupManage.asyncGroupBlock(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
将成员加入黑名单
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupBlock" %}{% endlanying_code_snippet %}
groupManage.asyncGroupUnblock(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
解除黑名单
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGroupUnblock" %}{% endlanying_code_snippet %}
groupManage.asyncKick(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
踢出群组
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncKick" %}{% endlanying_code_snippet %}
groupManage.asyncGetInvitationList() ⇒ Promise.<Array.<module:types~GroupInvitation>>#
获取群邀请列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupInvitation>> - 群邀请列表
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetInvitationList" %}{% endlanying_code_snippet %}
groupManage.asyncInvite(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
邀请成员加入群
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncInvite" %}{% endlanying_code_snippet %}
groupManage.asyncInviteHandle(params) ⇒ Promise.<boolean>#
处理群邀请
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_id | number | 用户ID |
| params.approval | boolean | 审批结果:true为同意,false为拒绝 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncInviteHandle" %}{% endlanying_code_snippet %}
groupManage.asyncGetMemberDisplayName(params) ⇒ Promise.<Array.<module:types~GroupMember>>#
批量获取群成员的群名片
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - 群成员列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.user_list | Array.<number> | 群成员列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetMemberDisplayName" %}{% endlanying_code_snippet %}
groupManage.asyncLeave(params) ⇒ Promise.<boolean>#
退出群
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncLeave" %}{% endlanying_code_snippet %}
groupManage.asyncUpdateDisplayName(params) ⇒ Promise.<boolean>#
修改群名片
Kind: static method of groupManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.value | string | 新名片 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncUpdateDisplayName" %}{% endlanying_code_snippet %}
groupManage.asncGetApplicationList(params) ⇒ Promise.<Array.<module:types~GroupApplication>>#
获取群申请列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupApplication>> - 群申请列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_list | Array.<number> | 群列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asncGetApplicationList" %}{% endlanying_code_snippet %}
groupManage.asyncGetFileList(params) ⇒ Promise.<Array.<module:types~GroupSharedFile>>#
获取群文件列表
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFile>> - 群文件列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncGetFileList" %}{% endlanying_code_snippet %}
groupManage.asyncFileDelete(params) ⇒ Promise.<Array.<module:types~GroupSharedFileResponse>>#
删除群文件
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFileResponse>> - 结果列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群组ID |
| params.file_list | Array.<number> | 文件ID列表 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncFileDelete" %}{% endlanying_code_snippet %}
groupManage.asyncFileUpload(params) ⇒ Promise.<Array.<module:types~GroupSharedFile>>#
上传群文件
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFile>> - 群文件列表
| Param | Type | Description |
|---|---|---|
| params | object | 参数 |
| params.group_id | number | 群id,int64 |
| params.name | string | 文件名称 |
| params.size | number | 文件大小,int64 |
| params.type | string | 文件类型 |
| params.url | string | 文件url |
Example
{% lanying_code_snippet repo="lanying-im-web",class="groupManage",function="asyncFileUpload" %}{% endlanying_code_snippet %}