groupManage#
groupManage#
Group management
- 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>#
Get group information
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - Group info
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
| froce | boolean | Whether to force pull from server: true - pull from server, false - prefer to pull from local storage |
groupManage.asyncGetJoinedGroups(froce) ⇒ Promise.<Array.<number>>#
Get the group to join
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - Group ID list
| Param | Type | Description |
|---|---|---|
| froce | boolean | Whether to force pull from server: true - pull from server, false - prefer to pull from local storage |
groupManage.openGroup(group_id)#
Open group, this method will prepare some necessary information for the group chat screen.
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
groupManage.getAllGroupDetail() ⇒ Object.<number, module:types~GroupInfoAndSettings>#
Get all cached group details
Kind: static method of groupManage
Returns: Object.<number, module:types~GroupInfoAndSettings> - Group details
Example
groupManage.asyncGetGroupMembers(group_id) ⇒ Promise.<Array.<number>>#
Get group member ids (asynchronous)
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - List of group member ids
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
groupManage.getGroupMembers(group_id) ⇒ Array.<GroupMember>#
Get group members (synchronous)
Kind: static method of groupManage
Returns: Array.<GroupMember> - List of group members
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
groupManage.asyncGetGroupListDetail(gids) ⇒ Promise.<Array.<module:types~BriefGroupInfoAndSettings>>#
Get group details by id
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~BriefGroupInfoAndSettings>> - List of group details
| Param | Type | Description |
|---|---|---|
| gids | Array.<number> | Group ID list |
groupManage.getGruopMessage(gid) ⇒ Array.<Meta>#
Get group information
Kind: static method of groupManage
Returns: Array.<Meta> - List of group messages
| Param | Type | Description |
|---|---|---|
| gid | number | GroupID |
groupManage.asyncGetInfo(params) ⇒ Promise.<GroupInfoAndSettings>#
Get group details
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - Group details
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncGetMemberList(param) ⇒ Promise.<Array.<module:types~GroupMember>>#
Get group member list
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - List of group members
| Param | Type | Description |
|---|---|---|
| param | object | Parameter |
| params.group_id | number | GroupID |
groupManage.readGroupMessage(group_id, mid)#
Set group message to read
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
| mid | number | MessageID |
groupManage.recallMessage(uid, mid)#
Revoke message
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| uid | number | GroupID |
| mid | number | MessageID |
groupManage.appendMessageContent(uid, mid, content)#
Append message content
Kind: static method of groupManage
| Param | Type | Description |
|---|---|---|
| uid | number | SessionID |
| mid | number | MessageID |
| content | string | Appended message content |
groupManage.replaceMessage(uid, mid, content, config, ext)#
Update message content
Kind: static method of groupManage
| Param | Type | Default | Description |
|---|---|---|---|
| uid | number | SessionID | |
| mid | number | MessageID | |
| content | string | Updated message content | |
| config | string | object | null | Updated message configuration |
| ext | string | object | null | Updated message extension data |
groupManage.getUnreadCount(gid) ⇒ number#
Get number of unread group messages
Kind: static method of groupManage
Returns: number - Unread message-number
| Param | Type | Description |
|---|---|---|
| gid | number | GroupID |
groupManage.asyncGetAdminList(params) ⇒ Promise.<Array.<module:types~GroupMember>>#
Get the list of group Admins
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - List of group admins
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncAdminAdd(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Add group Admin
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncAdminRemove(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Remove group Admin
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncGetAnouncementById(params) ⇒ Promise.<GroupAnnouncement>#
Get group announcement details
Kind: static method of groupManage
Returns: Promise.<GroupAnnouncement> - Group announcement details
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.announcement_id | Array.<number> | Announcement ID |
groupManage.asyncAnouncementDelete(params) ⇒ Promise.<boolean>#
Delete group announcement
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.announcement_id | Array.<number> | Announcement ID |
groupManage.asyncAnnouncementEdit(params) ⇒ Promise.<GroupAnnouncement>#
Edit group announcement
Kind: static method of groupManage
Returns: Promise.<GroupAnnouncement> - Group announcement details
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.title | string | Announcement tittle |
| params.content | string | Announcement content |
groupManage.asyncGetAnnouncementList(params) ⇒ Promise.<Array.<module:types~GroupAnnouncement>>#
Group announcement list
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupAnnouncement>> - List of group announcement details
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncCreate(params) ⇒ Promise.<GroupInfoAndSettings>#
Create group
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - Group details
| Param | Type | Description |
|---|---|---|
| params | GroupInfoRequest | Request parameters |
groupManage.asyncDestroy(params) ⇒ Promise.<boolean>#
Dissolve group
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncUpdateAvatar(params) ⇒ Promise.<boolean>#
Update group avatar
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | string | AvatarAddress |
groupManage.asyncUpdateDescription(params) ⇒ Promise.<boolean>#
Update group description
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | string | Group description |
groupManage.asyncUpdateExt(params) ⇒ Promise.<boolean>#
Update group extension information
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | string | Extension information |
groupManage.asyncUpdateName(params) ⇒ Promise.<boolean>#
Update group name
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | string | Group name |
groupManage.asyncGroupMsgMutemode(params) ⇒ Promise.<boolean>#
Set do-not-disturb conditions for group message
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.msg_mute_mode | number | Group message blocking mode: 0 - no blocking, 1 - blocking local message notifications, 2 - blocking all, means not receiving messages |
groupManage.asyncGroupBannedList(params) ⇒ Promise.<Array.<module:types~GroupMemberBanned>>#
Get group ban list
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMemberBanned>> - List of banned members
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncGroupBab(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Ban group member
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of request results
| Param | Type | Description |
|---|---|---|
| params | GroupBannedMemberRequest | Request parameters |
groupManage.asyncGroupUnban(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Unban group memberBan
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of request results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncGetSettings(group_id) ⇒ Promise.<GroupInfoAndSettings>#
Get group settings
Kind: static method of groupManage
Returns: Promise.<GroupInfoAndSettings> - Group settings
| Param | Type | Description |
|---|---|---|
| group_id | number | GroupID |
groupManage.asyncUpdateAllowMemberInvitation(params) ⇒ Promise.<boolean>#
Set whether group members can invite new member
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | boolean | Group member invite settings: false - do not allow invitations, true - allow invitations (default) |
groupManage.asyncUpdateAllowMemberModify(params) ⇒ Promise.<boolean>#
Set whether group members can modify group information
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | boolean | Group members modify group info settings: false - group members can't modify group info (default), true - group members can modify group info |
groupManage.asyncUpdateEnableReadack(params) ⇒ Promise.<boolean>#
Set whether to enable read mode in group
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | boolean | Enable or disable group message read feature: false - disabled, true - enabled |
groupManage.asyncUpdateHistoryVisible(params) ⇒ Promise.<boolean>#
Set whether group history is visible
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | boolean | Set whether the group history is visible: false - not visible, true - visible |
groupManage.asyncUpdateRequireadminapproval(params) ⇒ Promise.<boolean>#
Set whether need to apply for group joining
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.apply_approval | boolean | Group membership application settings, 0: Agree all requests 1: Need to confirm by Admin 2: Reject all requests |
groupManage.asyncBanAll(params) ⇒ Promise.<GroupBanAllResponse>#
Ban all members, only Admins can send messages
Kind: static method of groupManage
Returns: Promise.<GroupBanAllResponse> - Results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.duration | number | Duration of banned in minutes,int64 |
| params.group_id | number | Group id,int64 |
groupManage.asyncUnBanAll(params) ⇒ Promise.<boolean>#
Unban all members
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | Group id,int64 |
groupManage.asyncOwnerTransfer(params) ⇒ Promise.<GroupUserRelationResponse>#
Change group Owner
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - Results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.new_owner | number | User ID of the new group owner |
groupManage.asyncGetUserJoined(params) ⇒ Promise.<Array.<number>>#
Get the list of groups for the user
Kind: static method of groupManage
Returns: Promise.<Array.<number>> - List of group IDs
| Param | Type | Description |
|---|---|---|
| params | object | Parameter, Empty object |
groupManage.asyncApply(params) ⇒ Promise.<GroupUserRelationResponse>#
Apply to join group
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - Results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.reason | string | Reason for membership application |
groupManage.asyncApplyHandle(params) ⇒ Promise.<GroupUserRelationResponse>#
Process user's group joining application
Kind: static method of groupManage
Returns: Promise.<GroupUserRelationResponse> - Results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_id | number | User ID |
| params.approval | boolean | Approval result: true for agree, false for reject |
groupManage.asyncGroupBockedlist(params) ⇒ Promise.<Array.<module:types~GroupBlockedListItem>>#
Get group blacklist
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupBlockedListItem>> - GroupList of blacklists
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncGroupBlock(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Add member to blacklist
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncGroupUnblock(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Remove member from blacklist
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncKick(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Kick out group member
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncGetInvitationList() ⇒ Promise.<Array.<module:types~GroupInvitation>>#
Get group invitation list
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupInvitation>> - List of group invitations
Example
groupManage.asyncInvite(params) ⇒ Promise.<Array.<module:types~GroupUserRelationResponse>>#
Invite member to group
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupUserRelationResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncInviteHandle(params) ⇒ Promise.<boolean>#
Process group invitations
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_id | number | User ID |
| params.approval | boolean | Approval result: true for agree, false for reject |
groupManage.asyncGetMemberDisplayName(params) ⇒ Promise.<Array.<module:types~GroupMember>>#
Batch retrieval of group member profiles
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupMember>> - List of group members
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.user_list | Array.<number> | List of group members |
groupManage.asyncLeave(params) ⇒ Promise.<boolean>#
Quit group
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncUpdateDisplayName(params) ⇒ Promise.<boolean>#
Modify group profile
Kind: static method of groupManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.value | string | New user profile |
groupManage.asncGetApplicationList(params) ⇒ Promise.<Array.<module:types~GroupApplication>>#
Get the list of group membership requests
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupApplication>> - List of group applications
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_list | Array.<number> | List of groups |
groupManage.asyncGetFileList(params) ⇒ Promise.<Array.<module:types~GroupSharedFile>>#
Get the list of group files
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFile>> - List of group files
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
groupManage.asyncFileDelete(params) ⇒ Promise.<Array.<module:types~GroupSharedFileResponse>>#
Delete group file
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFileResponse>> - List of results
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | GroupID |
| params.file_list | Array.<number> | List of file IDs |
groupManage.asyncFileUpload(params) ⇒ Promise.<Array.<module:types~GroupSharedFile>>#
Upload group file
Kind: static method of groupManage
Returns: Promise.<Array.<module:types~GroupSharedFile>> - List of group files
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.group_id | number | Group id,int64 |
| params.name | string | File name |
| params.size | number | File size,int64 |
| params.type | string | File type |
| params.url | string | File url |