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 %}