Options
All
  • Public
  • Public/Protected
  • All
Menu

Class V2TimGroupManager

Hierarchy

  • V2TimGroupManager

Index

Methods

Methods

acceptGroupApplication

createGroup

  • createGroup(groupType: string, groupName: string, groupID?: string, notification?: string, introduction?: string, faceUrl?: string, isAllMuted?: Boolean, isSupportTopic?: boolean, addOpt?: GroupAddOptEnum, memberList?: V2TimGroupMember[]): Promise<V2TimValueCallback<string>>

  • 创建自定义群组

    Parameters

    • groupType: string
    • groupName: string
    • Optional groupID: string
    • Optional notification: string
    • Optional introduction: string
    • Optional faceUrl: string
    • Optional isAllMuted: Boolean
    • isSupportTopic: boolean = false
    • addOpt: GroupAddOptEnum = GroupAddOptEnum.V2TIM_GROUP_ADD_AUTH
    • Optional memberList: V2TimGroupMember[]

    Returns Promise<V2TimValueCallback<string>>

createTopicInCommunity

deleteGroupAttributes

  • deleteGroupAttributes(groupID: string, keys: string[]): Promise<V2TimCallback>

deleteTopicFromCommunity

  • deleteTopicFromCommunity(groupID: string, topicIDList: string[]): any

  • 删除话题

    Parameters

    • groupID: string
    • topicIDList: string[]

    Returns any

getGroupApplicationList

getGroupAttributes

getGroupMemberList

  • 获取群成员列表
    note

    直播群（AVChatRoom）的特殊限制：

    • 旗舰版支持拉取最近入群群成员最多 1000 人，新进来的成员排在前面。需要您购买旗舰版套餐且前往 控制台 开启开关。如果不开启开关，您只能像非旗舰版一样最多拉到 31 人（6.3 及以上版本支持）。
    • 非旗舰版支持拉取最近入群群成员最多 31 人，新进来的成员排在前面。
    • 程序重启后，请重新加入群组，否则拉取群成员会报 10007 错误码。
    • 群成员资料信息仅支持 userID | nickName | faceURL | role 字段。
    • filter 字段不支持管理员角色，即不支持管理员角色的拉取。如果您的业务逻辑依赖于管理员角色，可以使用群自定义字段 groupAttributes 管理该角色。

    Parameters

    • groupID: string

      群ID

    • filter: GroupMemberFilterTypeEnum

      指定群成员类型

    • nextSeq: string

      分页拉取标志，第一次拉取填 0，回调成功如果 nextSeq 不为零，需要分页，传入再次拉取，直至为 0。

    • count: number = 15

      拉群量

    • offset: number = 0

      偏移量

    Returns Promise<V2TimValueCallback<V2TimGroupMemberInfoResult>>

getGroupMembersInfo

getGroupOnlineMemberCount

getGroupsInfo

getJoinedCommunityList

getJoinedGroupList

getTopicInfoList

initGroupAttributes

inviteUserToGroup

kickGroupMember

  • kickGroupMember(groupID: string, memberList: string[]): Promise<V2TimCallback>

muteGroupMember

  • muteGroupMember(groupID: string, userID: string, seconds: number): Promise<V2TimCallback>

refuseGroupApplication

searchGroupMembers

  • searchGroupMembers(__namedParameters: { groupIDList?: string[]; isSearchMemberNameCard?: boolean; isSearchMemberNickName?: boolean; isSearchMemberRemark?: boolean; isSearchMemberUserID?: boolean; keywordList: string[] }): Promise<V2TimValueCallback<{ groupMemberSearchResultItems: StringMap }>>

  • 搜索指定的群成员资料

    SDK 会在本地搜索指定群 ID 列表中，群成员信息（名片、好友备注、昵称、userID）包含于关键字列表 keywordList 的所有群成员并返回群 ID 和群成员列表的 map，关键字列表最多支持5个。

    note

    需要您购买旗舰版套餐

    Parameters

    • __namedParameters: { groupIDList?: string[]; isSearchMemberNameCard?: boolean; isSearchMemberNickName?: boolean; isSearchMemberRemark?: boolean; isSearchMemberUserID?: boolean; keywordList: string[] }
      • Optional groupIDList?: string[]
      • Optional isSearchMemberNameCard?: boolean
      • Optional isSearchMemberNickName?: boolean
      • Optional isSearchMemberRemark?: boolean
      • Optional isSearchMemberUserID?: boolean
      • keywordList: string[]

    Returns Promise<V2TimValueCallback<{ groupMemberSearchResultItems: StringMap }>>

searchGroups

  • searchGroups(__namedParameters: { isSearchGroupID?: boolean; isSearchGroupName?: boolean; keywordList: string[] }): Promise<V2TimValueCallback<V2TimGroupInfo[]>>

  • 搜索群列表

    SDK 会搜索群名称包含于关键字列表 keywordList 的所有群并返回群信息列表。关键字列表最多支持5个。

    note

    需要您购买旗舰版套餐

    Parameters

    • __namedParameters: { isSearchGroupID?: boolean; isSearchGroupName?: boolean; keywordList: string[] }
      • Optional isSearchGroupID?: boolean
      • Optional isSearchGroupName?: boolean
      • keywordList: string[]

    Returns Promise<V2TimValueCallback<V2TimGroupInfo[]>>

setGroupApplicationRead

setGroupAttributes

setGroupInfo

setGroupMemberInfo

  • setGroupMemberInfo(groupID: string, userID: string, nameCard?: string, customInfo?: StringMap): Promise<V2TimCallback>

setGroupMemberRole

  • 切换群成员的角色
    note

    请注意不同类型的群有如下限制：

    • 公开群（Public）和会议群（Meeting）：只有群主才能对群成员进行普通成员和管理员之间的角色切换。
    • 其他群不支持设置群成员角色。
    • 转让群组请调用 transferGroupOwner 接口。
    • 会议群（Meeting）切换群成员角色之后，不会有 onGrantAdministrator 和 onRevokeAdministrator 通知回调
    • 切换的角色支持普通群成员（ V2TIM_GROUP_MEMBER_ROLE_MEMBER） 和管理员（V2TIM_GROUP_MEMBER_ROLE_ADMIN

    Parameters

    Returns Promise<V2TimCallback>

setTopicInfo

transferGroupOwner

  • transferGroupOwner(groupID: string, userID: string): Promise<V2TimCallback>

  • 转让群主
    note

    请注意不同类型的群有如下限制：

    • 普通类型的群（Work、Public、Meeting）：只有群主才有权限进行群转让操作。
    • 直播群（AVChatRoom）：不支持转让群主。

    Parameters

    • groupID: string
    • userID: string

    Returns Promise<V2TimCallback>