v2::V2NIMClient类 参考

#include <v2_nim_api.hpp>

Public 成员函数
nstd::optional< V2NIMError >	init (const V2NIMInitOption &option)
	初始化
virtual nstd::optional< V2NIMError >	initImpl (const V2NIMInitOption &option)=0
nstd::optional< V2NIMError >	uninit ()
	反初始化
virtual nstd::optional< V2NIMError >	uninitImpl ()=0
virtual nstd::optional< V2NIMError >	updateAppKey (const nstd::string &appKey)=0
	重新设置 App key，您可以在不重新初始化的情况下切换 App key
virtual V2NIMLoginService &	getLoginService () const =0
	获取登录服务
virtual V2NIMConversationService &	getConversationService () const =0
	获取会话服务
virtual V2NIMConversationGroupService &	getConversationGroupService () const =0
	获取会话分组服务
virtual V2NIMMessageService &	getMessageService () const =0
	获取消息服务
virtual V2NIMNotificationService &	getNotificationService () const =0
	获取通知服务
virtual V2NIMStorageService &	getStorageService () const =0
	获取存储服务
virtual V2NIMTeamService &	getTeamService () const =0
	获取群组服务
virtual V2NIMSettingService &	getSettingService () const =0
	获取设置服务
virtual V2NIMUserService &	getUserService () const =0
	获取用户资料服务
virtual V2NIMFriendService &	getFriendService () const =0
	获取好友服务
virtual V2NIMAIService &	getAIService () const =0
	获取 AI 服务
virtual V2NIMSignallingService &	getSignallingService () const =0
	获取信令服务
virtual V2NIMSubscriptionService &	getSubscriptionService () const =0
	获取订阅服务
virtual V2NIMPassthroughService &	getPassthroughService () const =0
	获取透传服务

静态 Public 成员函数
static V2NIMClient &	get ()
	获取 IM 客户端实例

成员函数说明

get()

V2NIMClient & v2::V2NIMClient::get ( )

inlinestatic

获取 IM 客户端实例

返回

V2NIMClient&

示例代码

auto& client = V2NIMClient::get();

getAIService()

virtual V2NIMAIService & v2::V2NIMClient::getAIService ( ) const

pure virtual

获取 AI 服务

返回

V2NIMAIService&

示例代码

auto& aiService = client.getAIService();

getConversationGroupService()

virtual V2NIMConversationGroupService & v2::V2NIMClient::getConversationGroupService ( ) const

pure virtual

获取会话分组服务

返回

V2NIMConversationGroupService&

示例代码

auto& conversationGroupService = client.getConversationGroupService();

getConversationService()

virtual V2NIMConversationService & v2::V2NIMClient::getConversationService ( ) const

pure virtual

获取会话服务

返回

V2NIMConversationService&

示例代码

auto& conversationService = client.getConversationService();

getFriendService()

virtual V2NIMFriendService & v2::V2NIMClient::getFriendService ( ) const

pure virtual

获取好友服务

返回

V2NIMFriendService&

示例代码

auto& friendService = client.getFriendService();

getLoginService()

virtual V2NIMLoginService & v2::V2NIMClient::getLoginService ( ) const

pure virtual

获取登录服务

返回

V2NIMLoginService&

示例代码

auto& loginService = client.getLoginService();

getMessageService()

virtual V2NIMMessageService & v2::V2NIMClient::getMessageService ( ) const

pure virtual

获取消息服务

返回

V2NIMMessageService&

示例代码

auto& messageService = client.getMessageService();

getNotificationService()

virtual V2NIMNotificationService & v2::V2NIMClient::getNotificationService ( ) const

pure virtual

获取通知服务

返回

V2NIMNotificationService&

示例代码

auto& notificationService = client.getNotificationService();

getPassthroughService()

virtual V2NIMPassthroughService & v2::V2NIMClient::getPassthroughService ( ) const

pure virtual

获取透传服务

返回

V2NIMPassthroughService&

示例代码

auto& passthroughService = client.getPassthroughService();

getSettingService()

virtual V2NIMSettingService & v2::V2NIMClient::getSettingService ( ) const

pure virtual

获取设置服务

返回

V2NIMSettingService&

示例代码

auto& settingService = client.getSettingService();

getSignallingService()

virtual V2NIMSignallingService & v2::V2NIMClient::getSignallingService ( ) const

pure virtual

获取信令服务

返回

V2NIMSignallingService&

示例代码

auto& signallingService = client.getSignallingService();

getStorageService()

virtual V2NIMStorageService & v2::V2NIMClient::getStorageService ( ) const

pure virtual

获取存储服务

返回

V2NIMStorageService&

示例代码

auto& storageService = client.getStorageService();

getSubscriptionService()

virtual V2NIMSubscriptionService & v2::V2NIMClient::getSubscriptionService ( ) const

pure virtual

获取订阅服务

返回

V2NIMSubscriptionService&

示例代码

auto& subscriptionService = client.getSubscriptionService();

getTeamService()

virtual V2NIMTeamService & v2::V2NIMClient::getTeamService ( ) const

pure virtual

获取群组服务

返回

V2NIMTeamService&

示例代码

auto& teamService = client.getTeamService();

getUserService()

virtual V2NIMUserService & v2::V2NIMClient::getUserService ( ) const

pure virtual

获取用户资料服务

返回

V2NIMUserService&

示例代码

auto& userService = client.getUserService();

init()

nstd::optional< V2NIMError > v2::V2NIMClient::init ( const V2NIMInitOption &  option )

inline

初始化

参数

option

初始化选项

返回

nstd::optional<V2NIMError>

示例代码

V2NIMInitOption option;
option.appkey = "your app key";
option.appDataPath = "your app name";
auto error = client.init(option);
if (error) {
    // init failed
    // ...
    return;
}

initImpl()

virtual nstd::optional< V2NIMError > v2::V2NIMClient::initImpl ( const V2NIMInitOption &  option )

pure virtual

uninit()

nstd::optional< V2NIMError > v2::V2NIMClient::uninit ( )

inline

反初始化

返回

nstd::optional<V2NIMError>

示例代码

auto error = client.uninit();
if (error) {
    // uninit failed
    // ...
    return;
}

uninitImpl()

virtual nstd::optional< V2NIMError > v2::V2NIMClient::uninitImpl ( )

pure virtual

updateAppKey()

virtual nstd::optional< V2NIMError > v2::V2NIMClient::updateAppKey ( const nstd::string &  appKey )

pure virtual

重新设置 App key，您可以在不重新初始化的情况下切换 App key

参数

appKey

新的 App key

返回

nstd::optional<V2NIMError>

示例代码

auto error = client.updateAppKey("new app key");
if (error) {
    // update app key failed
}

---

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

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