NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
v2::V2NIMClient类 参考abstract

#include <v2_nim_api.hpp>

Public 成员函数

nstd::optional< V2NIMErrorinit (const V2NIMInitOption &option)
 初始化
 
virtual nstd::optional< V2NIMErrorinitImpl (const V2NIMInitOption &option)=0
 
nstd::optional< V2NIMErroruninit ()
 反初始化
 
virtual nstd::optional< V2NIMErroruninitImpl ()=0
 
virtual V2NIMLoginServicegetLoginService () const =0
 获取登录服务
 
virtual V2NIMConversationServicegetConversationService () const =0
 获取会话服务
 
virtual V2NIMConversationGroupServicegetConversationGroupService () const =0
 获取会话分组服务
 
virtual V2NIMMessageServicegetMessageService () const =0
 获取消息服务
 
virtual V2NIMNotificationServicegetNotificationService () const =0
 获取通知服务
 
virtual V2NIMStorageServicegetStorageService () const =0
 获取存储服务
 
virtual V2NIMTeamServicegetTeamService () const =0
 获取群组服务
 
virtual V2NIMSettingServicegetSettingService () const =0
 获取设置服务
 
virtual V2NIMUserServicegetUserService () const =0
 获取用户资料服务
 
virtual V2NIMFriendServicegetFriendService () const =0
 获取好友服务
 
virtual V2NIMAIServicegetAIService () const =0
 获取 AI 服务
 
virtual V2NIMSignallingServicegetSignallingService () const =0
 获取信令服务
 
virtual V2NIMSubscriptionServicegetSubscriptionService () const =0
 获取订阅服务
 

静态 Public 成员函数

static V2NIMClientget ()
 获取 IM 客户端实例
 

成员函数说明

◆ get()

V2NIMClient & v2::V2NIMClient::get ( )
inlinestatic

获取 IM 客户端实例

返回
V2NIMClient&
示例代码
auto& client = V2NIMClient::get();
static V2NIMClient & get()
获取 IM 客户端实例
Definition: v2_nim_api.hpp:428

◆ 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();

◆ 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>
示例代码
option.appkey = "your app key";
option.appDataPath = "your app name";
auto error = client.init(option);
if (error) {
// init failed
// ...
return;
}
Definition: v2_nim_def_struct.hpp:117
nstd::string appDataPath
app 数据目录, 为空则使用默认目录
Definition: v2_nim_def_struct.hpp:121
nstd::string appkey
app key
Definition: v2_nim_def_struct.hpp:119

◆ 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

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