v2::V2NIMConversationService类 参考

会话服务 更多...

#include <v2_nim_conversation_service.hpp>

Public 成员函数
virtual void	createConversation (nstd::string conversationId, V2NIMSuccessCallback< V2NIMConversation > success, V2NIMFailureCallback failure)=0
	创建空会话
virtual void	deleteConversation (nstd::string conversationId, bool clearMessage, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	删除会话
virtual void	deleteConversationListByIds (nstd::vector< nstd::string > conversationIds, bool clearMessage, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > > success, V2NIMFailureCallback failure)=0
	批量删除会话
virtual void	stickTopConversation (nstd::string conversationId, bool stickTop, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	置顶会话
virtual void	updateConversation (nstd::string conversationId, V2NIMConversationUpdate updateInfo, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	更新会话
virtual void	updateConversationLocalExtension (nstd::string conversationId, nstd::string localExtension, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	更新会话本地扩展
virtual void	getConversation (nstd::string conversationId, V2NIMSuccessCallback< V2NIMConversation > success, V2NIMFailureCallback failure)=0
	获取会话
virtual void	getConversationList (uint64_t offset, uint32_t limit, V2NIMSuccessCallback< V2NIMConversationResult > success, V2NIMFailureCallback failure)=0
	分页获取会话列表
virtual void	getConversationListByIds (nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversation > > success, V2NIMFailureCallback failure)=0
	根据会话ID获取会话列表
virtual void	getConversationListByOption (uint64_t offset, uint32_t limit, V2NIMConversationOption option, V2NIMSuccessCallback< V2NIMConversationResult > success, V2NIMFailureCallback failure)=0
	根据条件筛选分页获取会话列表
virtual uint32_t	getTotalUnreadCount ()=0
	获取会话未读总数
virtual void	getUnreadCountByIds (nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< uint32_t > success, V2NIMFailureCallback failure)=0
	根据会话 ID 列表获取未读总数
virtual void	getUnreadCountByFilter (V2NIMConversationFilter filter, V2NIMSuccessCallback< uint32_t > success, V2NIMFailureCallback failure)=0
	根据过滤条件获取会话未读总数
virtual void	clearTotalUnreadCount (V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	清除会话总未读数
virtual void	clearUnreadCountByIds (nstd::vector< nstd::string > conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > > success, V2NIMFailureCallback failure)=0
	根据会话 ID 列表清除会话未读数
virtual void	clearUnreadCountByTypes (nstd::vector< V2NIMConversationType > conversationTypes, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	根据会话类型清除会话未读数
virtual void	clearUnreadCountByGroupId (nstd::string groupId, V2NIMSuccessCallback< void > success, V2NIMFailureCallback failure)=0
	根据会话分组清除会话未读数
virtual nstd::optional< V2NIMError >	subscribeUnreadCountByFilter (V2NIMConversationFilter filter)=0
	订阅指定过滤条件的会话未读数
virtual nstd::optional< V2NIMError >	unsubscribeUnreadCountByFilter (V2NIMConversationFilter filter)=0
	取消订阅指定过滤条件的会话未读数
virtual void	markConversationRead (nstd::string conversationId, V2NIMSuccessCallback< time_t > success, V2NIMFailureCallback failure)=0
	标记会话已读时间戳
virtual void	getConversationReadTime (nstd::string conversationId, V2NIMSuccessCallback< time_t > success, V2NIMFailureCallback failure)=0
	获取会话已读时间戳
virtual void	addConversationListener (V2NIMConversationListener listener)=0
	添加会话监听
virtual void	removeConversationListener (V2NIMConversationListener listener)=0
	移除会话监听

详细描述

会话服务

前置条件

调用 V2NIMClient::get() 拿到 client 实例 调用 client.getConversationService() 拿到 conversationService 实例

示例代码

auto& client = V2NIMClient::get();
auto& conversationService = client.getConversationService();

成员函数说明

addConversationListener()

virtual void v2::V2NIMConversationService::addConversationListener ( V2NIMConversationListener  listener )

pure virtual

添加会话监听

参数

listener

会话监听

返回

void

示例代码

V2NIMConversationListener listener;
listener.onSyncStarted = []() {
    // handle conversation sync start event
};
listener.onSyncFinished = []() {
    // handle conversation sync finish event
};
listener.onSyncFailed = [](V2NIMError error) {
    // handle conversation sync failed event
};
listener.onConversationCreated = [](V2NIMConversation conversation) {
    // handle conversation created event
};
listener.onConversationDeleted = [](nstd::vector<nstd::string> conversationIds) {
    // handle conversation deleted event
};
listener.onConversationChanged = [](nstd::vector<V2NIMConversation> conversationList) {
    // handle conversation changed event
};
listener.onTotalUnreadCountChanged = [](uint32_t unreadCount) {
    // handle total unread count changed event
};
listener.onUnreadCountChangedByFilter = [](V2NIMConversationFilter filter, uint32_t unreadCount) {
    // handle unread count changed by group event
};
conversationService.addConversationListener(listener);

clearTotalUnreadCount()

virtual void v2::V2NIMConversationService::clearTotalUnreadCount ( V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

清除会话总未读数

参数

success	成功回调
failure	失败回调

返回

void

示例代码

conversationService.clearTotalUnreadCount(
    []() {
        // clear total unread count succeeded
    },
    [](V2NIMError error) {
        // clear total unread count failed, handle error
    });

clearUnreadCountByGroupId()

virtual void v2::V2NIMConversationService::clearUnreadCountByGroupId ( nstd::string  groupId, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

根据会话分组清除会话未读数

参数

groupId	会话分组 ID
success	成功回调
failure	失败回调

返回

void

示例代码

conversationService.clearUnreadCountByGroupId(
    "groupId",
    []() {
        // clear unread count succeeded
    },
    [](V2NIMError error) {
        // clear unread count failed, handle error
    });

clearUnreadCountByIds()

virtual void v2::V2NIMConversationService::clearUnreadCountByIds ( nstd::vector< nstd::string >  conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > >  success, V2NIMFailureCallback  failure  )

pure virtual

根据会话 ID 列表清除会话未读数

参数

conversationIds	会话 ID 列表
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationIds = nstd::vector<nstd::string>();
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account2"));
conversationService.clearUnreadCountByIds(
    conversationIds,
    [](nstd::vector<V2NIMConversationOperationResult> failedList) {
        // clear unread count succeeded
    },
    [](V2NIMError error) {
        // clear unread count failed, handle error
    });

clearUnreadCountByTypes()

virtual void v2::V2NIMConversationService::clearUnreadCountByTypes ( nstd::vector< V2NIMConversationType >  conversationTypes, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

根据会话类型清除会话未读数

参数

conversationTypes
success	成功回调
failure	失败回调

返回

void

示例代码

conversationService.clearUnreadCountByTypes(
    {V2NIM_CONVERSATION_TYPE_P2P, V2NIM_CONVERSATION_TYPE_TEAM},
    []() {
        // clear unread count succeeded
    },
    [](V2NIMError error) {
        // clear unread count failed, handle error
    });

createConversation()

virtual void v2::V2NIMConversationService::createConversation ( nstd::string  conversationId, V2NIMSuccessCallback< V2NIMConversation >  success, V2NIMFailureCallback  failure  )

pure virtual

创建空会话

参数

conversationId	会话 ID
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
conversationService.createConversation(
    conversationId,
    [](V2NIMConversation conversation) {
        // create succeeded
    },
    [](V2NIMError error) {
        // create failed, handle error
    });

deleteConversation()

virtual void v2::V2NIMConversationService::deleteConversation ( nstd::string  conversationId, bool  clearMessage, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

删除会话

参数

conversationId	会话 ID
clearMessage	是否清除会话消息
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
conversationService.deleteConversation(
    conversationId,
    true,
    []() {
        // delete succeeded
    },
    [](V2NIMError error) {
        // delete failed, handle error
    });

deleteConversationListByIds()

virtual void v2::V2NIMConversationService::deleteConversationListByIds ( nstd::vector< nstd::string >  conversationIds, bool  clearMessage, V2NIMSuccessCallback< nstd::vector< V2NIMConversationOperationResult > >  success, V2NIMFailureCallback  failure  )

pure virtual

批量删除会话

参数

conversationIds	会话ID列表
clearMessage	是否清除会话消息
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationIds = nstd::vector<nstd::string>();
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account2"));
conversationService.deleteConversationListByIds(
    conversationIds,
    true,
    [](nstd::vector<V2NIMConversationOperationResult> failedList) {
        // delete succeeded
    },
    [](V2NIMError error) {
        // delete failed, handle error
    });

getConversation()

virtual void v2::V2NIMConversationService::getConversation ( nstd::string  conversationId, V2NIMSuccessCallback< V2NIMConversation >  success, V2NIMFailureCallback  failure  )

pure virtual

获取会话

参数

conversationId	会话 ID
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
conversationService.getConversation(
    conversationId,
    [](V2NIMConversation conversation) {
        // get conversation succeeded
    },
    [](V2NIMError error) {
        // get conversation failed, handle error
    });

getConversationList()

virtual void v2::V2NIMConversationService::getConversationList ( uint64_t  offset, uint32_t  limit, V2NIMSuccessCallback< V2NIMConversationResult >  success, V2NIMFailureCallback  failure  )

pure virtual

分页获取会话列表

参数

offset	分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
limit	分页数量
success	成功回调
failure	失败回调

返回

void

示例代码

conversationService.getConversationList(
    lastCursor,
    10,
    [](V2NIMConversationResult result) {
        // get conversation list succeeded
    },
    [](V2NIMError error) {
        // get conversation list failed, handle error
    });

getConversationListByIds()

virtual void v2::V2NIMConversationService::getConversationListByIds ( nstd::vector< nstd::string >  conversationIds, V2NIMSuccessCallback< nstd::vector< V2NIMConversation > >  success, V2NIMFailureCallback  failure  )

pure virtual

根据会话ID获取会话列表

参数

conversationIds	会话ID列表
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationIds = nstd::vector<nstd::string>();
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account2"));
conversationService.getConversationListByIds(
    conversationIds,
    [](nstd::vector<V2NIMConversation> conversationList) {
        // get conversation list succeeded
    },
    [](V2NIMError error) {
        // get conversation list failed, handle error
    });

getConversationListByOption()

virtual void v2::V2NIMConversationService::getConversationListByOption ( uint64_t  offset, uint32_t  limit, V2NIMConversationOption  option, V2NIMSuccessCallback< V2NIMConversationResult >  success, V2NIMFailureCallback  failure  )

pure virtual

根据条件筛选分页获取会话列表

参数

offset	分页偏移, 首页传 0, 后续拉取采用上一次返还的 offset
limit	分页数量
option	查询参数
success	成功回调
failure	失败回调

返回

void

示例代码

V2NIMConversationOption option;
option.onlyUnread = true;
option.conversationTypes = {V2NIM_CONVERSATION_TYPE_P2P, V2NIM_CONVERSATION_TYPE_TEAM};
conversationService.getConversationListByOption(
    lastCursor,
    10,
    option,
    [](V2NIMConversationResult result) {
        // get conversation list succeeded
    },
    [](V2NIMError error) {
        // get conversation list failed, handle error
    });

getConversationReadTime()

virtual void v2::V2NIMConversationService::getConversationReadTime ( nstd::string  conversationId, V2NIMSuccessCallback< time_t >  success, V2NIMFailureCallback  failure  )

pure virtual

获取会话已读时间戳

参数

conversationId	要获取的会话 ID
success	成功回调
failure	失败回调

示例代码

conversationService.getConversationReadTime(
    "conversationId",
    [](time_t readTime) {
        // get conversation read time succeeded
    },
    [](V2NIMError error) {
        // get conversation read time failed, handle error
    )};

getTotalUnreadCount()

virtual uint32_t v2::V2NIMConversationService::getTotalUnreadCount ( )

pure virtual

获取会话未读总数

参数

conversationId

会话 ID

返回

uint32_t 未读总数

示例代码

auto totalUnreadCount = conversationService.getTotalUnreadCount();

getUnreadCountByFilter()

virtual void v2::V2NIMConversationService::getUnreadCountByFilter ( V2NIMConversationFilter  filter, V2NIMSuccessCallback< uint32_t >  success, V2NIMFailureCallback  failure  )

pure virtual

根据过滤条件获取会话未读总数

参数

filter	过滤条件
success	成功回调
failure	失败回调

返回

void

示例代码

V2NIMConversationFilter filter;
filter.conversationTypes = {V2NIM_CONVERSATION_TYPE_P2P, V2NIM_CONVERSATION_TYPE_TEAM};
conversationService.getUnreadCountByFilter(
    filter,
    [](uint32_t count) {
        // get unread count succeeded
    },
    [](V2NIMError error) {
        // get unread count failed, handle error
    });

getUnreadCountByIds()

virtual void v2::V2NIMConversationService::getUnreadCountByIds ( nstd::vector< nstd::string >  conversationIds, V2NIMSuccessCallback< uint32_t >  success, V2NIMFailureCallback  failure  )

pure virtual

根据会话 ID 列表获取未读总数

参数

conversationIds	会话 ID 列表
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationIds = nstd::vector<nstd::string>();
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account1"));
conversationIds.emplace_back(V2NIMConversationIdUtil::p2pConversationId("account2"));
conversationService.getUnreadCountByIds(
    conversationIds,
    [](uint32_t count) {
        // get unread count succeeded
    },
    [](V2NIMError error) {
        // get unread count failed, handle error
    });

markConversationRead()

virtual void v2::V2NIMConversationService::markConversationRead ( nstd::string  conversationId, V2NIMSuccessCallback< time_t >  success, V2NIMFailureCallback  failure  )

pure virtual

标记会话已读时间戳

参数

conversationId	要标记的会话 ID
success	成功回调
failure	失败回调

示例代码

conversationService.markConversationRead(
    "conversationId",
    []() {
        // mark conversation read succeeded
    },
    [](V2NIMError error) {
        // mark conversation read failed, handle error
    )};

removeConversationListener()

virtual void v2::V2NIMConversationService::removeConversationListener ( V2NIMConversationListener  listener )

pure virtual

移除会话监听

参数

listener

会话监听

返回

void

示例代码

V2NIMConversationListener listener;
// ...
conversationService.addConversationListener(listener);
// ...
conversationService.removeConversationListener(listener);

stickTopConversation()

virtual void v2::V2NIMConversationService::stickTopConversation ( nstd::string  conversationId, bool  stickTop, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

置顶会话

参数

conversationId	会话 ID
stickTop	是否置顶
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
conversationService.stickTopConversation(
    conversationId,
    true,
    []() {
        // stick top succeeded
    },
    [](V2NIMError error) {
        // stick top failed, handle error
    });

subscribeUnreadCountByFilter()

virtual nstd::optional< V2NIMError > v2::V2NIMConversationService::subscribeUnreadCountByFilter ( V2NIMConversationFilter  filter )

pure virtual

订阅指定过滤条件的会话未读数

参数

filter

过滤条件

返回

nstd::optional<V2NIMError>

示例代码

V2NIMConversationFilter filter;
filter.conversationTypes = {V2NIM_CONVERSATION_TYPE_P2P, V2NIM_CONVERSATION_TYPE_TEAM};
auto error = conversationService.subscribeUnreadCountByFilter(filter);
if (error) {
    // subscribe failed, handle error
}

unsubscribeUnreadCountByFilter()

virtual nstd::optional< V2NIMError > v2::V2NIMConversationService::unsubscribeUnreadCountByFilter ( V2NIMConversationFilter  filter )

pure virtual

取消订阅指定过滤条件的会话未读数

参数

filter

过滤条件

返回

nstd::optional<V2NIMError>

示例代码

auto error = conversationService.unsubscribeUnreadCountByFilter(filter);
if (error) {
    // unsubscribe failed, handle error
}

updateConversation()

virtual void v2::V2NIMConversationService::updateConversation ( nstd::string  conversationId, V2NIMConversationUpdate  updateInfo, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

更新会话

参数

conversationId	会话 ID
updateInfo	更新参数
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
V2NIMConversationUpdate updateInfo;
updateInfo.serverExtension = "serverExtension";
conversationService.updateConversation(
    conversationId,
    updateInfo,
    []() {
        // update succeeded
    },
    [](V2NIMError error) {
        // update failed, handle error
    });

updateConversationLocalExtension()

virtual void v2::V2NIMConversationService::updateConversationLocalExtension ( nstd::string  conversationId, nstd::string  localExtension, V2NIMSuccessCallback< void >  success, V2NIMFailureCallback  failure  )

pure virtual

更新会话本地扩展

参数

conversationId	会话 ID
localExtension	本地扩展
success	成功回调
failure	失败回调

返回

void

示例代码

auto conversationId = V2NIMConversationIdUtil::p2pConversationId("account1");
conversationService.updateConversationLocalExtension(
    conversationId,
    "localExtension",
    []() {
        // update succeeded
    },
    [](V2NIMError error) {
        // update failed, handle error
    });

---

该类的文档由以下文件生成:

• D:/GitLab/builds/7_aFT3sv/0/nim-pc/california/nim-cross-platform-sdk/exports/include/v2_nim_conversation_service.hpp