NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
v2::V2NIMConversationGroupService类 参考abstract

会话分组服务 更多...

#include <v2_nim_conversation_group_service.hpp>

Public 成员函数

virtual void createConversationGroup (nstd::string name, nstd::optional< nstd::string > serverExtension, nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< V2NIMConversationGroupResult > success, V2NIMFailureCallback failure)=0
 创建会话分组
 
virtual void deleteConversationGroup (nstd::string groupId, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
 删除会话分组
 
virtual void updateConversationGroup (nstd::string groupId, nstd::optional< nstd::string > name, nstd::optional< nstd::string > serverExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
 更新会话分组
 
virtual void addConversationsToGroup (nstd::string groupId, nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > > success, V2NIMFailureCallback failure)=0
 添加会话到会话分组
 
virtual void removeConversationsFromGroup (nstd::string groupId, nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > > success, V2NIMFailureCallback failure)=0
 从会话分组中移除会话
 
virtual void getConversationGroup (nstd::string groupId, V2NIMSuccessCallback< V2NIMConversationGroup > success, V2NIMFailureCallback failure)=0
 获取会话分组信息
 
virtual void getConversationGroupList (V2NIMSuccessCallback< nstd::vector< V2NIMConversationGroup > > success, V2NIMFailureCallback failure)=0
 获取会话分组列表
 
virtual void getConversationGroupListByIds (nstd::vector< nstd::string > groupIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversationGroup > > success, V2NIMFailureCallback failure)=0
 根据会话分组 ID 获取会话分组
 
virtual void addConversationGroupListener (V2NIMConversationGroupListener listener)=0
 添加会话分组监听
 
virtual void removeConversationGroupListener (V2NIMConversationGroupListener listener)=0
 移除会话分组监听
 

详细描述

会话分组服务

前置条件
调用 V2NIMClient::get() 拿到 client 实例 调用 client.getConversationgGroupService() 拿到 conversationGroupService 实例
示例代码
auto& client = V2NIMClient::get();
auto& conversationGroupService = client.getConversationgGroupService();
v2::V2NIMClient::get
static V2NIMClient & get()
获取 IM 客户端实例
Definition: v2_nim_api.hpp:428

成员函数说明

◆ addConversationGroupListener()

virtual void v2::V2NIMConversationGroupService::addConversationGroupListener ( V2NIMConversationGroupListener  listener)
pure virtual

添加会话分组监听

参数
listener会话分组监听
示例代码
V2NIMConversationGroupListener listener;
listener.onConversationGroupCreated = [](V2NIMConversationGroup conversationGroup) {
// handle conversation group created event
};
listener.onConversationGroupDeleted = [](nstd::string groupId) {
// handle conversation group deleted event
};
listener.onConversationGroupChanged = [](V2NIMConversationGroup conversationGroup) {
// handle conversation group changed event
};
listener.onConversationsAddedToGroup = [](nstd::string groupId, nstd::vector<V2NIMConversation> conversationList) {
// handle conversation add to group event
};
listener.onConversationsRemovedFromGroup = [](nstd::string groupId, nstd::vector<nstd::string> conversationIds) {
// handle conversation remove from group event
};
conversationGroupService.addConversationGroupListener(listener);
nstd::_continuous_container
Definition: ne_stl_continuous_container.h:15
nstd::_string
Definition: ne_stl_string.h:19
v2::V2NIMConversationGroupListener
Definition: v2_nim_def_callback.hpp:96
v2::V2NIMConversationGroupListener::onConversationGroupChanged
nstd::function< void(V2NIMConversationGroup conversationGroup)> onConversationGroupChanged
会话分组更新
Definition: v2_nim_def_callback.hpp:102
v2::V2NIMConversationGroupListener::onConversationsRemovedFromGroup
nstd::function< void(nstd::string groupId, nstd::vector< nstd::string > conversationIds)> onConversationsRemovedFromGroup
会话移出会话分组
Definition: v2_nim_def_callback.hpp:106
v2::V2NIMConversationGroupListener::onConversationGroupDeleted
nstd::function< void(nstd::string groupId)> onConversationGroupDeleted
会话分组删除
Definition: v2_nim_def_callback.hpp:100
v2::V2NIMConversationGroupListener::onConversationsAddedToGroup
nstd::function< void(nstd::string groupId, nstd::vector< V2NIMConversation > conversationList)> onConversationsAddedToGroup
会话加入会话分组
Definition: v2_nim_def_callback.hpp:104
v2::V2NIMConversationGroupListener::onConversationGroupCreated
nstd::function< void(V2NIMConversationGroup conversationGroup)> onConversationGroupCreated
会话分组创建
Definition: v2_nim_def_callback.hpp:98
v2::V2NIMConversationGroup
Definition: v2_nim_def_struct.hpp:1263

◆ addConversationsToGroup()

virtual void v2::V2NIMConversationGroupService::addConversationsToGroup ( nstd::string  groupId,
nstd::vector< nstd::string >  conversationIds,
V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > >  success,
V2NIMFailureCallback  failure 
)
pure virtual

添加会话到会话分组

参数
groupId会话分组 ID
conversationIds会话 ID 列表
success成功回调
failure失败回调
示例代码
auto conversationIds = nstd::vector<nstd::string>{};
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::teamConversationId("team1"));
conversationGroupService.addConversationsToGroup(
"groupId",
conversationIds,
[](nstd::vector<V2NIMConversationOperationResult> failedList) {
// add conversations to group succeeded
},
[](V2NIMError error) {
// add conversations to group failed, handle error
});
v2::V2NIMConversationIdUtil::p2pConversationId
static nstd::string p2pConversationId(const nstd::string &accountId)
获取点对点会话ID
Definition: v2_nim_internal.hpp:246
v2::V2NIMConversationIdUtil::teamConversationId
static nstd::string teamConversationId(const nstd::string &teamId)
获取群组会话ID
Definition: v2_nim_internal.hpp:249

◆ createConversationGroup()

virtual void v2::V2NIMConversationGroupService::createConversationGroup ( nstd::string  name,
nstd::optional< nstd::string >  serverExtension,
nstd::vector< nstd::string >  conversationIds,
V2NIMSuccessCallback< V2NIMConversationGroupResult >  success,
V2NIMFailureCallback  failure 
)
pure virtual

创建会话分组

参数
name会话分组名称
serverExtension扩展字段
conversationIds会话 ID 列表
success成功回调
failure失败回调
示例代码
auto conversationIds = nstd::vector<nstd::string>{};
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::teamConversationId("team1"));
conversationGroupService.createConversationGroup(
"group1",
"serverExtension",
conversationIds,
[](V2NIMConversationGroupResult result) {
// create conversation group succeeded
},
[](V2NIMError error) {
// create conversation group failed, handle error
});
v2::V2NIMConversationGroupResult
Definition: v2_nim_def_struct.hpp:1276

◆ deleteConversationGroup()

virtual void v2::V2NIMConversationGroupService::deleteConversationGroup ( nstd::string  groupId,
V2NIMSuccessCallback< void >  success,
V2NIMFailureCallback  failure 
)
pure virtual

删除会话分组

参数
groupId会话分组 ID
success成功回调
failure失败回调
示例代码
conversationGroupService.deleteConversationGroup(
"groupId",
[]() {
// delete conversation group succeeded
},
[](V2NIMError error) {
// delete conversation group failed, handle error
});
v2::V2NIMError
Definition: v2_nim_def_struct.hpp:7

◆ getConversationGroup()

virtual void v2::V2NIMConversationGroupService::getConversationGroup ( nstd::string  groupId,
V2NIMSuccessCallback< V2NIMConversationGroup >  success,
V2NIMFailureCallback  failure 
)
pure virtual

获取会话分组信息

参数
groupId会话分组 ID
success成功回调
failure失败回调
示例代码
conversationGroupService.getConversationGroup(
"groupId",
[](V2NIMConversationGroup group) {
// get conversation group succeeded
},
[](V2NIMError error) {
// get conversation group failed, handle error
});

◆ getConversationGroupList()

virtual void v2::V2NIMConversationGroupService::getConversationGroupList ( V2NIMSuccessCallback< nstd::vector< V2NIMConversationGroup > >  success,
V2NIMFailureCallback  failure 
)
pure virtual

获取会话分组列表

参数
success成功回调
failure失败回调
示例代码
conversationGroupService.getConversationGroupList(
[](nstd::vector<V2NIMConversationGroup> groupList) {
// get conversation group list succeeded
},
[](V2NIMError error) {
// get conversation group list failed, handle error
});

◆ getConversationGroupListByIds()

virtual void v2::V2NIMConversationGroupService::getConversationGroupListByIds ( nstd::vector< nstd::string >  groupIds,
V2NIMSuccessCallback< nstd::vector< V2NIMConversationGroup > >  success,
V2NIMFailureCallback  failure 
)
pure virtual

根据会话分组 ID 获取会话分组

参数
groupId会话分组 ID
success成功回调
failure失败回调
示例代码
auto groupIds = nstd::vector<nstd::string>{};
groupIds.emplace_back("groupId1");
groupIds.emplace_back("groupId2");
conversationGroupService.getConversationGroupListByIds(
groupIds,
[](nstd::vector<V2NIMConversationGroup> groupList) {
// get conversation group list by ids succeeded
},
[](V2NIMError error) {
// get conversation group list by ids failed, handle error
});

◆ removeConversationGroupListener()

virtual void v2::V2NIMConversationGroupService::removeConversationGroupListener ( V2NIMConversationGroupListener  listener)
pure virtual

移除会话分组监听

参数
listener会话分组监听
示例代码
V2NIMConversationGroupListener listener;
// ...
conversationGroupService.addConversationGroupListener(listener);
// ...
conversationGroupService.removeConversationGroupListener(listener);

◆ removeConversationsFromGroup()

virtual void v2::V2NIMConversationGroupService::removeConversationsFromGroup ( nstd::string  groupId,
nstd::vector< nstd::string >  conversationIds,
V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > >  success,
V2NIMFailureCallback  failure 
)
pure virtual

从会话分组中移除会话

参数
groupId会话分组 ID
conversationIds会话 ID 列表
success成功回调
failure失败回调
示例代码
auto conversationIds = nstd::vector<nstd::string>{};
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::teamConversationId("team1"));
conversationGroupService.removeConversationsFromGroup(
"groupId",
conversationIds,
[](nstd::vector<V2NIMConversationOperationResult> failedList) {
// remove conversations from group succeeded
},
[](V2NIMError error) {
// remove conversations from group failed, handle error
});

◆ updateConversationGroup()

virtual void v2::V2NIMConversationGroupService::updateConversationGroup ( nstd::string  groupId,
nstd::optional< nstd::string >  name,
nstd::optional< nstd::string >  serverExtension,
V2NIMSuccessCallback< void >  success,
V2NIMFailureCallback  failure 
)
pure virtual

更新会话分组

参数
groupId会话分组 ID
name新的会话分组名称
serverExtension扩展字段
success成功回调
failure失败回调
示例代码
conversationGroupService.updateConversationGroup(
"groupId",
"name",
"serverExtension",
[]() {
// update conversation group succeeded
},
[](V2NIMError error) {
// update conversation group failed, handle error
});
该类的文档由以下文件生成: