NIM CPP SDK  8.0.0
Classes | Typedefs | Enumerations | Functions | Variables
nim Namespace Reference

namespace nim More...

Classes

struct  AudioInfo
 语音信息,用于语音转文字 More...
 
struct  BlackMuteListInfo
 黑名单 静音名单信息 More...
 
struct  BroadcastMessage
 
class  CallbackProxy
 
class  Client
 全局管理功能;主要包括SDK初始化/清理、客户端登录/退出等功能 More...
 
struct  CollectInfo
 收藏内容属性 More...
 
struct  CollectInfoList
 收藏列表 More...
 
class  DataSync
 NIM SDK提供的数据同步相关接口 More...
 
struct  DeleteFriendOption
 删除好有拓展选项 More...
 
struct  DeleteMsglogSelfNotifyItemInfo
 单向删除消息记录回调参数 More...
 
struct  DeleteMsglogSelfNotifyParam
 单向删除消息记录回调参数 More...
 
class  DocTrans
 NIM SDK提供的文档转换相关接口 More...
 
struct  DocTransInfo
 文档传输信息 More...
 
struct  DownloadMediaResult
 下载完成的结果 More...
 
struct  EventData
 事件数据 More...
 
struct  EventOnlineClientType
 在线客户端类型,此结构体只用于在线状态事件的kNIMEventNimConfig字段 More...
 
struct  EventSubscribeData
 事件订阅数据 More...
 
class  Friend
 NIM 好友相关接口 More...
 
struct  FriendAddEvent
 云信好友变更事件(请求添加) More...
 
struct  FriendChangeEvent
 云信好友变更事件 More...
 
struct  FriendDelEvent
 云信好友变更事件(删除) More...
 
struct  FriendProfile
 云信好友 More...
 
struct  FriendProfileSyncEvent
 云信好友变更事件(多端同步) More...
 
struct  FriendProfileUpdateEvent
 云信好友变更事件(更新) More...
 
class  Global
 NIM SDK提供的一些全局接口 More...
 
struct  IMAudio
 语音消息附件 More...
 
struct  IMBotRobot
 波特机器人消息附件 More...
 
struct  IMFile
 文件消息附件 More...
 
struct  IMImage
 图片消息附件 More...
 
struct  IMLocation
 位置消息附件 More...
 
struct  IMMessage
 
struct  IMMessageThreadInfo
 P2P和群组消息 More...
 
struct  IMVideo
 小视频消息附件 More...
 
struct  InitNosConfigParam
 初始化nos参数 More...
 
struct  InitNosResult
 初始化结果 More...
 
struct  KickOtherRes
 踢人结果回调信息 More...
 
struct  KickoutRes
 被踢结果回调信息 More...
 
struct  LoginRes
 登录结果回调信息 More...
 
class  LogsBackupExportInfo
 导出消息记录到云端参数定义 More...
 
class  LogsBackupImportInfo
 从云端导入消息记录参数定义 More...
 
struct  MatchCollectParm
 收藏匹配参数 More...
 
struct  MessageSetting
 消息属性设置 More...
 
struct  MessageStatusChanged
 发送消息已读回执 More...
 
struct  MessageStatusChangedResult
 发送消息已读回执 More...
 
struct  ModifyPinMessageParam
 修改、取消Pin Message参数定义 More...
 
class  MsgLog
 NIM SDK提供的消息历史接口 More...
 
struct  MultiSpotLoginRes
 多端登录回调信息 More...
 
struct  NetDetectCbInfo
 网络探测回调信息 More...
 
class  NOS
 NIM SDK提供的NOS云存储服务接口 More...
 
struct  OtherClientPres
 多端登陆客户端信息 More...
 
class  PassThroughProxy
 
struct  PictureInfo
 文档传输的图片信息 More...
 
struct  PinMessageInfo
 Pin消息属性 More...
 
class  PluginIn
 NIM SDK 提供的plugin接入接口类 More...
 
struct  ProgressData
 传输过程中的数据 More...
 
struct  QueryAllPinMessageResponse
 查询Pin Message应答参数定义 More...
 
struct  QueryCollectsParm
 分页查询收藏列表参数 More...
 
struct  QueryMsglogResult
 查询到消息历史结果 More...
 
struct  QueryQuickCommentsParam
 查询快捷回复参数定义 More...
 
struct  QueryQuickCommentsResponse
 查询快捷回复参数定义 More...
 
struct  QuickCommentInfo
 快捷回复属性 More...
 
struct  RecallMsgNotify
 消息撤回通知 More...
 
struct  RemoveCollectsParm
 收藏内容参数 More...
 
struct  RemoveQuickCommentParam
 删除快捷回复参数定义 More...
 
class  Robot
 NIM SDK提供的Robot接口 More...
 
struct  RobotInfo
 机器人信息 More...
 
class  Rts
 NIM Rts提供的相关接口 More...
 
struct  RtsStartInfo
 点对点白板发起的参数信息 More...
 
struct  SDKConfig
 SDK设置项 More...
 
class  SDKInstance
 SDK库辅助类,提供加载/卸载SDK库以及获取接口的方法 More...
 
struct  SendMessageArc
 发送消息回执 More...
 
class  Session
 会话列表管理功能;主要包括查询会话列表、删除会话列表等功能 More...
 
struct  SessionData
 会话数据 More...
 
struct  SessionDataList
 会话列表数据 More...
 
class  SessionOnLineService
 
class  SessionOnLineServiceHelper
 
class  Signaling
 namespace nim More...
 
struct  SignalingAcceptParam
 接受邀请接口nim_signaling_accept的传入参数 More...
 
struct  SignalingAcceptResParam
 接受邀请结果回调信息,在自动加入成功后返回有效 More...
 
struct  SignalingCallParam
 呼叫接口nim_signaling_call的传入参数 More...
 
struct  SignalingCallResParam
 呼叫结果回调信息 More...
 
struct  SignalingCancelInviteParam
 取消邀请接口nim_signaling_cancel_invite的传入参数 More...
 
struct  SignalingCancelInviteResParam
 取消邀请结果回调信息,暂时为空 More...
 
struct  SignalingChannelDetailedinfo
 频道的详细信息,包含频道信息及成员列表 More...
 
struct  SignalingChannelInfo
 频道属性 More...
 
struct  SignalingCloseParam
 关闭频道接口nim_signaling_close的传入参数 More...
 
struct  SignalingCloseResParam
 关闭频道结果回调信息 More...
 
struct  SignalingControlParam
 控制通知接口nim_signaling_control的传入参数 More...
 
struct  SignalingControlResParam
 控制通知结果回调信息,暂时为空 More...
 
struct  SignalingCreateParam
 创建频道接口nim_signaling_create的传入参数 More...
 
struct  SignalingCreateResParam
 创建频道结果回调信息 More...
 
struct  SignalingInviteParam
 邀请接口nim_signaling_invite的传入参数 More...
 
struct  SignalingInviteResParam
 邀请结果回调信息,暂时为空 More...
 
struct  SignalingJoinParam
 加入频道接口nim_signaling_query_channel_info的传入参数 More...
 
struct  SignalingJoinResParam
 加入频道结果回调信息 More...
 
struct  SignalingLeaveParam
 离开频道接口nim_signaling_leave的传入参数 More...
 
struct  SignalingLeaveResParam
 离开频道结果回调信息,暂时为空 More...
 
struct  SignalingMemberInfo
 成员属性 More...
 
struct  SignalingNotifyInfo
 事件通知信息基类 More...
 
struct  SignalingNotifyInfoAccept
 接收邀请事件通知信息,event_type_=kNIMSignalingEventTypeAccept More...
 
struct  SignalingNotifyInfoCancelInvite
 取消邀请事件通知信息,event_type_=kNIMSignalingEventTypeCancelInvite More...
 
struct  SignalingNotifyInfoClose
 频道关闭事件通知信息,event_type_=kNIMSignalingEventTypeClose More...
 
struct  SignalingNotifyInfoControl
 控制事件通知信息,event_type_=kNIMSignalingEventTypeCtrl More...
 
struct  SignalingNotifyInfoInvite
 邀请事件通知信息,event_type_=kNIMSignalingEventTypeInvite More...
 
struct  SignalingNotifyInfoJoin
 加入频道事件通知信息,event_type_=kNIMSignalingEventTypeJoin More...
 
struct  SignalingNotifyInfoLeave
 退出频道事件通知信息,event_type_=kNIMSignalingEventTypeLeave More...
 
struct  SignalingNotifyInfoReject
 拒绝邀请事件通知信息,event_type_=kNIMSignalingEventTypeReject More...
 
struct  SignalingPushInfo
 推送属性 More...
 
struct  SignalingQueryChannelInfoParam
 查询频道接口nim_signaling_join的传入参数 More...
 
struct  SignalingQueryChannelInfoResParam
 查询频道结果回调信息 More...
 
struct  SignalingRejectParam
 拒绝接口nim_signaling_reject的传入参数 More...
 
struct  SignalingRejectResParam
 拒绝邀请结果回调信息,暂时为空 More...
 
struct  SignalingResParam
 独立信令操作回调参数基类 More...
 
struct  SpecialRelationshipChangeEvent
 黑名单和静音名单变更通知 More...
 
struct  StickTopSession
 
struct  StickTopSessionInfo
 会话数据 More...
 
struct  StickTopSessionList
 
class  SubscribeEvent
 NIM 订阅事件相关接口 More...
 
class  SuperTeam
 超大群组功能;主要包括查询群信息、查询群成员信息、加人、踢人等功能 More...
 
struct  SuperTeamEvent
 群组事件通知 More...
 
struct  SuperTeamInfo
 群组信息 More...
 
struct  SuperTeamMemberProperty
 群组成员信息 More...
 
struct  SysMessage
 系统消息和自定义通知数据 More...
 
struct  SysMessageSetting
 系统消息和自定义通知属性设置 More...
 
class  SystemMsg
 系统消息接口;主要包括查询系统消息、删除系统消息等功能 More...
 
class  Talk
 聊天功能;主要包括发送消息、接收消息等功能 More...
 
class  TalkEx
 聊天功能;主要包括收藏、快捷回复、PinMessage、ThreadMessage、置顶会话 More...
 
class  Team
 群组功能;主要包括查询群信息、查询群成员信息、加人、踢人等功能 More...
 
struct  TeamEvent
 群组事件通知 More...
 
struct  TeamInfo
 群组信息 More...
 
struct  TeamMemberProperty
 群组成员信息 More...
 
class  Tool
 NIM SDK提供的一些工具接口,主要包括获取SDK里app account对应的app data目录,计算md5等 More...
 
struct  UploadMediaResult
 上传完成的结果 More...
 
class  User
 NIM SDK提供的用户相关接口 More...
 
struct  UserNameCard
 云信用户名片 More...
 
class  VChat
 

Typedefs

typedef std::list< RobotInfoRobotInfos
 

Enumerations

enum  UserNameCardValueKey {
  kUserNameCardKeyNone = 0, kUserNameCardKeyName = 1, kUserNameCardKeyIconUrl = 1 << 1, kUserNameCardKeyGender = 1 << 2,
  kUserNameCardKeyBirthday = 1 << 3, kUserNameCardKeyMobile = 1 << 4, kUserNameCardKeyEmail = 1 << 5, kUserNameCardKeySignature = 1 << 6,
  kUserNameCardKeyEx = 1 << 7, kUserNameCardKeyAll = (1 << 8) - 1
}
 

Functions

bool NIM_SDK_CPPWRAPPER_DLL_API ParseOtherClientsPres (const nim_cpp_wrapper_util::Json::Value array_objs, std::list< OtherClientPres > &outs)
 
NIM_SDK_CPPWRAPPER_DLL_API void UnregNIMCallback ()
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseDocTransInfo (const std::string &json, DocTransInfo &info)
 解析文档传输信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API int32_t ParseDocTransInfos (const std::string &json, std::list< DocTransInfo > &info_list)
 解析一组文档传输信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseFriendsProfile (const std::string &friends_profile_json, std::list< FriendProfile > &profiles)
 解析(多)好友信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseFriendProfile (const std::string &friend_profile_json, FriendProfile &profile)
 解析(单个)好友信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseFriendProfile (const nim_cpp_wrapper_util::Json::Value &friend_profile_json, FriendProfile &profile)
 解析(单个)好友信息 More...
 
bool StrListToJsonString (const std::list< std::string > &list, std::string &out)
 将一个string类型的list组装成一个Json Array More...
 
bool JsonStrArrayToList (const nim_cpp_wrapper_util::Json::Value &array_str, std::list< std::string > &out)
 将一个string类型的Json Array解析成一个string类型的list More...
 
bool JsonArrayStringToList (const std::string &array_str, std::list< std::string > &out)
 将一个string类型的Json Array解析成一个string类型的list More...
 
bool ParseJsonValue (const std::string &content, nim_cpp_wrapper_util::Json::Value &values)
 解析JsonString More...
 
std::string GetJsonStringWithNoStyled (const nim_cpp_wrapper_util::Json::Value &values)
 获得非格式化的Json string,传入SDK的json string格式要求为非格式化的,如果是格式化的json string可能会影响功能 More...
 
nim_cpp_wrapper_util::Json::Value GetJsonValueFromJsonString (const std::string &json_string)
 解析JsonString More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseRecallMsgNotify (const std::string json_value, RecallMsgNotify &notify)
 解析消息撤回通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseRecallMsgNotify (const std::string &notify_json, std::list< RecallMsgNotify > &notifys)
 解析消息撤回通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSendMessageAck (const std::string &arc_json, SendMessageArc &arc)
 解析发送消息回执 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseMsglogs (const std::string &msgs_json, QueryMsglogResult &res)
 解析查询到的消息历史结果 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseUploadResult (const std::string &url, const std::string &json, UploadMediaResult &res)
 解析NOS上传结果 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseDownloadResult (const std::string &file_path, const std::string &call_id, const std::string &res_id, DownloadMediaResult &res)
 解析NOS上传过程数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseProgressData (const std::string &json, ProgressData &res)
 解析NOS上传过程数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseRobotInfosStringToRobotInfos (const std::string &infos_json, RobotInfos &infos)
 解析机器人信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseRobotInfoStringToRobotInfo (const std::string &info_json, RobotInfo &info)
 解析机器人信息 More...
 
static void nim_print_unfound_func_name (char *name)
 
static void unfound_function_holder ()
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSession (const std::string &session_json, SessionData &session)
 解析会话信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseSession (const nim_cpp_wrapper_util::Json::Value &session_json, SessionData &session)
 解析会话信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSessionList (const std::string &sessions_json, SessionDataList &session_list)
 解析会话列表信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseStickTopSession (const std::string &session_json, StickTopSession &session)
 解析置顶会话信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseStickTopSession (const nim_cpp_wrapper_util::Json::Value &session_json, StickTopSession &session)
 解析置顶会话信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseStickTopSessionList (const std::string &sessions_json, StickTopSessionList &stick_top_session_list)
 解析置顶会话列表信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseEventData (const std::string &event_json, EventData &event_data)
 解析事件数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseEventData (const nim_cpp_wrapper_util::Json::Value &values, EventData &event_data)
 解析事件数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseEventDataList (const std::string &event_list_json, std::list< EventData > &event_data_list)
 解析批量事件数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseEventSubscribeData (const nim_cpp_wrapper_util::Json::Value &values, EventSubscribeData &event_subscribe)
 解析事件订阅数据 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseEventSubscribeDataList (const std::string &subscribe_list_json, std::list< EventSubscribeData > &event_subscribe_list)
 解析事件订阅数据列表 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseSuperTeamEvent (int rescode, const std::string &team_id, const NIMNotificationId notification_id, const std::string &team_event_json, SuperTeamEvent &team_event)
 解析群组事件通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseSuperTeamInfoJson (const nim_cpp_wrapper_util::Json::Value &team_info_json, SuperTeamInfo &team_info)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSuperTeamInfoJson (const std::string &team_info_json, SuperTeamInfo &team_info)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSuperTeamInfosJson (const std::string &team_infos_json, std::list< SuperTeamInfo > &team_infos)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseSuperTeamMemberPropertyJson (const nim_cpp_wrapper_util::Json::Value &team_member_prop_json, SuperTeamMemberProperty &team_member_property)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSuperTeamMemberPropertyJson (const std::string &team_member_prop_json, SuperTeamMemberProperty &team_member_property)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSuperTeamMemberPropertysJson (const std::string &team_member_props_json, std::list< SuperTeamMemberProperty > &team_member_propertys)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSysMessage (const std::string &sysmsg_json, SysMessage &msg)
 解析系统消息或自定义通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSysMessages (const std::string &sysmsgs_json, std::list< SysMessage > &msgs, int *unread)
 解析系统消息或自定义通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseSysMessageContent (const nim_cpp_wrapper_util::Json::Value &content_json, SysMessage &msg)
 解析系统消息或自定义通知的内容 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseMessage (const std::string &msg_json, IMMessage &message)
 解析消息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseReceiveMessage (const std::string &msg_json, IMMessage &message)
 解析消息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseReceiveMessage (const nim_cpp_wrapper_util::Json::Value &msg_json_value, IMMessage &message)
 解析消息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseMessage (const nim_cpp_wrapper_util::Json::Value &msg_json, IMMessage &message)
 解析消息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseTeamEvent (int rescode, const std::string &team_id, const NIMNotificationId notification_id, const std::string &team_event_json, TeamEvent &team_event)
 解析群组事件通知 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseTeamInfoJson (const nim_cpp_wrapper_util::Json::Value &team_info_json, TeamInfo &team_info)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseTeamInfoJson (const std::string &team_info_json, TeamInfo &team_info)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseTeamInfosJson (const std::string &team_infos_json, std::list< TeamInfo > &team_infos)
 解析群组信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseTeamMemberPropertyJson (const nim_cpp_wrapper_util::Json::Value &team_member_prop_json, TeamMemberProperty &team_member_property)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseTeamMemberPropertyJson (const std::string &team_member_prop_json, TeamMemberProperty &team_member_property)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseTeamMemberPropertysJson (const std::string &team_member_props_json, std::list< TeamMemberProperty > &team_member_propertys)
 解析群成员信息 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseNameCards (const std::string &namecards_json, std::list< UserNameCard > &namecards)
 解析用户名片 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseNameCards (const nim_cpp_wrapper_util::Json::Value &namecards_json, std::list< UserNameCard > &namecards)
 解析用户名片 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseNameCard (const std::string &namecard_json, UserNameCard &namecard)
 解析用户名片 More...
 
NIM_SDK_CPPWRAPPER_DLL_API void ParseNameCard (const nim_cpp_wrapper_util::Json::Value &namecard_json, UserNameCard &namecard)
 解析用户名片 More...
 
NIM_SDK_CPPWRAPPER_DLL_API bool ParseSpecialListInfo (const std::string &list_json, std::list< BlackMuteListInfo > &black_mute_list)
 解析黑名单/静音列表 More...
 

Variables

nim::SDKInstancenim_sdk_instance
 

Detailed Description

namespace nim

Enumeration Type Documentation

◆ UserNameCardValueKey

Enumerator
kUserNameCardKeyNone 

无内容

kUserNameCardKeyName 

昵称

kUserNameCardKeyIconUrl 

头像下载地址

kUserNameCardKeyGender 

性别

kUserNameCardKeyBirthday 

生日

kUserNameCardKeyMobile 

电话

kUserNameCardKeyEmail 

电子邮件

kUserNameCardKeySignature 

签名

kUserNameCardKeyEx 

扩展

kUserNameCardKeyAll 

全部内容都有

Function Documentation

◆ GetJsonStringWithNoStyled()

std::string nim::GetJsonStringWithNoStyled ( const nim_cpp_wrapper_util::Json::Value &  values)

获得非格式化的Json string,传入SDK的json string格式要求为非格式化的,如果是格式化的json string可能会影响功能

Parameters
[in]valuesJson Value
Returns
std::string 非格式化的json string

◆ GetJsonValueFromJsonString()

Json::Value nim::GetJsonValueFromJsonString ( const std::string &  json_string)

解析JsonString

Returns
JsonValue

◆ JsonArrayStringToList()

bool nim::JsonArrayStringToList ( const std::string &  array_str,
std::list< std::string > &  out 
)

将一个string类型的Json Array解析成一个string类型的list

Parameters
[in]array_strstring类型的Json Array
[out]outstring类型的list
Returns
bool 解析成功 或失败

◆ JsonStrArrayToList()

bool nim::JsonStrArrayToList ( const nim_cpp_wrapper_util::Json::Value &  array_str,
std::list< std::string > &  out 
)

将一个string类型的Json Array解析成一个string类型的list

Parameters
[in]array_strstring类型的Json Array
[out]outstring类型的list
Returns
bool 解析成功 或失败

◆ ParseDocTransInfo()

bool nim::ParseDocTransInfo ( const std::string &  json,
DocTransInfo info 
)

解析文档传输信息

Parameters
[in]json文档传输信息(Json Value数据字符串)
[out]infos文档传输信息
Returns
bool 解析成功 或失败

◆ ParseDocTransInfos()

int32_t nim::ParseDocTransInfos ( const std::string &  json,
std::list< DocTransInfo > &  infos 
)

解析一组文档传输信息

Parameters
[in]json文档传输信息(Json Value数据字符串)
[out]infos文档传输信息
Returns
int32_t 服务器总条数

◆ ParseDownloadResult()

bool nim::ParseDownloadResult ( const std::string &  file_path,
const std::string &  call_id,
const std::string &  res_id,
DownloadMediaResult res 
)

解析NOS上传过程数据

Parameters
[in]file_path下载文件地址
[in]call_id如果下载的是消息中的资源,则为消息所属的会话id,否则为空
[int]res_id 如果下载的是消息中的资源,则为消息id,否则为空
[in]jsonJson Value扩展数据
[out]res数据结构体
Returns
bool 解析成功 或失败

◆ ParseEventData() [1/2]

bool nim::ParseEventData ( const nim_cpp_wrapper_util::Json::Value &  values,
EventData event_data 
)

解析事件数据

Parameters
[in]values事件数据(Json Value数据字符串)
[out]event_data事件数据
Returns
bool 解析成功 或失败

◆ ParseEventData() [2/2]

bool nim::ParseEventData ( const std::string &  event_json,
EventData event_data 
)

解析事件数据

Parameters
[in]event_json事件数据(Json Value数据字符串)
[out]event_data事件数据
Returns
bool 解析成功 或失败

◆ ParseEventDataList()

bool nim::ParseEventDataList ( const std::string &  event_list_json,
std::list< EventData > &  event_data_list 
)

解析批量事件数据

Parameters
[in]event_list_json事件数据(Json Value数据字符串)
[out]event_data_list事件数据
Returns
bool 解析成功 或失败

◆ ParseEventSubscribeData()

bool nim::ParseEventSubscribeData ( const nim_cpp_wrapper_util::Json::Value &  values,
EventSubscribeData event_subscribe 
)

解析事件订阅数据

Parameters
[in]values事件订阅数据(Json Value数据)
[out]event_subscribe事件订阅数据
Returns
bool 解析成功 或失败

◆ ParseEventSubscribeDataList()

bool nim::ParseEventSubscribeDataList ( const std::string &  subscribe_list_json,
std::list< EventSubscribeData > &  event_subscribe_list 
)

解析事件订阅数据列表

Parameters
[in]subscribe_list_json事件订阅数据(Json Value数据字符串)
[out]event_subscribe_list事件订阅数据列表
Returns
bool 解析成功 或失败

◆ ParseFriendProfile() [1/2]

void nim::ParseFriendProfile ( const nim_cpp_wrapper_util::Json::Value &  friend_profile_json,
FriendProfile profile 
)

解析(单个)好友信息

Parameters
[in]friend_profile_json好友信息(Json Value数据)
[out]profile好友信息
Returns
void

◆ ParseFriendProfile() [2/2]

bool nim::ParseFriendProfile ( const std::string &  friend_profile_json,
FriendProfile profile 
)

解析(单个)好友信息

Parameters
[in]friend_profile_json好友信息(Json Value字符串)
[out]profile好友信息
Returns
bool 解析成功 或失败

◆ ParseFriendsProfile()

bool nim::ParseFriendsProfile ( const std::string &  friends_profile_json,
std::list< FriendProfile > &  profiles 
)

解析(多)好友信息

Parameters
[in]friends_profile_json好友信息(Json Value数据字符串)
[out]profiles好友信息
Returns
bool 解析成功 或失败

◆ ParseJsonValue()

bool nim::ParseJsonValue ( const std::string &  content,
nim_cpp_wrapper_util::Json::Value &  values 
)

解析JsonString

Parameters
[in]contentJsonString
[out]valuesJsonValue
Returns
bool 解析成功失败

◆ ParseMessage() [1/2]

void nim::ParseMessage ( const nim_cpp_wrapper_util::Json::Value &  msg_json,
IMMessage message 
)

解析消息

Parameters
[in]msg_json消息(Json Value数据)
[out]message消息
Returns
void

◆ ParseMessage() [2/2]

bool nim::ParseMessage ( const std::string &  msg_json,
IMMessage message 
)

解析消息

Parameters
[in]msg_json消息(Json Value数据字符串)
[out]message消息
Returns
bool 解析成功或失败

◆ ParseMsglogs()

bool nim::ParseMsglogs ( const std::string &  msgs_json,
QueryMsglogResult res 
)

解析查询到的消息历史结果

Parameters
[in]msgs_json查询到的消息历史(Json Value数据字符串)
[out]res消息历史结果
Returns
bool 解析成功 或失败

◆ ParseNameCard() [1/2]

void nim::ParseNameCard ( const nim_cpp_wrapper_util::Json::Value &  namecard_json,
UserNameCard namecard 
)

解析用户名片

Parameters
[in]namecard_json用户名片(Json Value数据)
[out]namecard用户名片
Returns
void

◆ ParseNameCard() [2/2]

bool nim::ParseNameCard ( const std::string &  namecard_json,
UserNameCard namecard 
)

解析用户名片

Parameters
[in]namecard_json用户名片(Json Value数据字符串)
[out]namecard用户名片
Returns
bool 解析成功或失败

◆ ParseNameCards() [1/2]

bool nim::ParseNameCards ( const nim_cpp_wrapper_util::Json::Value &  namecards_json,
std::list< UserNameCard > &  namecards 
)

解析用户名片

Parameters
[in]namecards_json用户名片(json array)
[out]namecards用户名片
Returns
bool 解析成功或失败

◆ ParseNameCards() [2/2]

bool nim::ParseNameCards ( const std::string &  namecards_json,
std::list< UserNameCard > &  namecards 
)

解析用户名片

Parameters
[in]namecards_json用户名片(Json Value数据字符串)
[out]namecards用户名片
Returns
bool 解析成功或失败

◆ ParseOtherClientsPres()

bool nim::ParseOtherClientsPres ( const nim_cpp_wrapper_util::Json::Value  array_objs,
std::list< OtherClientPres > &  outs 
)

解析多端登录客户端信息

Parameters
[in]array_objs多端登录客户端信息(Json Value数据)
[out]outs多端登录客户端信息
Returns
bool 解析成功 或失败

◆ ParseProgressData()

bool nim::ParseProgressData ( const std::string &  json,
ProgressData res 
)

解析NOS上传过程数据

Parameters
[in]jsonJson Value扩展数据
[out]res数据结构体
Returns
bool 解析成功 或失败

◆ ParseRecallMsgNotify() [1/2]

bool nim::ParseRecallMsgNotify ( const std::string &  notify_json,
std::list< RecallMsgNotify > &  notifys 
)

解析消息撤回通知

Parameters
[in]notify_json消息撤回通知(Json Value数据字符串)
[out]notifys消息撤回通知
Returns
bool 解析成功 或失败

◆ ParseRecallMsgNotify() [2/2]

bool bool nim::ParseRecallMsgNotify ( const std::string  json_value,
RecallMsgNotify notify 
)

解析消息撤回通知

Parameters
[in]json_value消息撤回通知json格式
[out]notify消息撤回通知
Returns
bool 解析成功 或失败

◆ ParseReceiveMessage() [1/2]

void nim::ParseReceiveMessage ( const nim_cpp_wrapper_util::Json::Value &  msg_json_value,
IMMessage message 
)

解析消息

Parameters
[in]msg_json_value消息
[out]message消息
Returns
bool 解析成功或失败

◆ ParseReceiveMessage() [2/2]

bool nim::ParseReceiveMessage ( const std::string &  msg_json,
IMMessage message 
)

解析消息

Parameters
[in]msg_json消息(Json Value数据字符串)
[out]message消息
Returns
bool 解析成功或失败

◆ ParseRobotInfosStringToRobotInfos()

bool nim::ParseRobotInfosStringToRobotInfos ( const std::string &  infos_json,
RobotInfos &  infos 
)

解析机器人信息

Parameters
[in]infos_json机器人信息(Json Value数据字符串)
[out]infos机器人信息
Returns
bool 解析成功或失败

◆ ParseRobotInfoStringToRobotInfo()

bool nim::ParseRobotInfoStringToRobotInfo ( const std::string &  info_json,
RobotInfo info 
)

解析机器人信息

Parameters
[in]info_json机器人信息
[out]info机器人信息
Returns
bool 解析成功或失败

◆ ParseSendMessageAck()

bool nim::ParseSendMessageAck ( const std::string &  arc_json,
SendMessageArc arc 
)

解析发送消息回执

Parameters
[in]arc_json发送消息回执(Json Value数据字符串)
[out]arc发送消息回执
Returns
bool 解析成功 或失败

◆ ParseSession() [1/2]

void nim::ParseSession ( const nim_cpp_wrapper_util::Json::Value &  session_json,
SessionData session 
)

解析会话信息

Parameters
[in]session_json会话信息(Json Value数据)
[out]session会话信息
Returns
void

◆ ParseSession() [2/2]

bool nim::ParseSession ( const std::string &  session_json,
SessionData session 
)

解析会话信息

Parameters
[in]session_json会话信息(Json Value数据字符串)
[out]session会话信息
Returns
bool 解析成功 或失败

◆ ParseSessionList()

bool nim::SessionOnLineServiceHelper::ParseSessionList ( const std::string &  sessions_json,
SessionDataList session_list 
)

解析会话列表信息

解析查询会话列表结果

Parameters
[in]sessions_json会话列表信息(Json Value数据字符串)
[out]session_list会话信息
Returns
bool 解析成功 或失败
Parameters
[in]sessions_json查询结果 (Json Value数据字符串)
[out]result会话信息
Returns
bool 解析成功 或失败

◆ ParseSpecialListInfo()

bool nim::ParseSpecialListInfo ( const std::string &  list_json,
std::list< BlackMuteListInfo > &  black_mute_list 
)

解析黑名单/静音列表

Parameters
[in]list_json黑名单/静音列表(Json Value数据字符串)
[out]black_mute_list黑名单/静音列表
Returns
bool 解析成功或失败

◆ ParseStickTopSession() [1/2]

void nim::ParseStickTopSession ( const nim_cpp_wrapper_util::Json::Value &  session_json,
StickTopSession session 
)

解析置顶会话信息

Parameters
[in]session_json置顶会话信息(Json Value数据)
[out]session置顶会话信息
Returns
void

◆ ParseStickTopSession() [2/2]

bool nim::ParseStickTopSession ( const std::string &  session_json,
StickTopSession session 
)

解析置顶会话信息

Parameters
[in]session_json置顶会话信息(Json Value数据字符串)
[out]session置顶会话信息
Returns
bool 解析成功 或失败

◆ ParseStickTopSessionList()

bool nim::ParseStickTopSessionList ( const std::string &  sessions_json,
StickTopSessionList stick_top_session_list 
)

解析置顶会话列表信息

Parameters
[in]sessions_json置顶会话列表信息(Json Value数据字符串)
[out]stick_top_session_list置顶会话信息
Returns
bool 解析成功 或失败

◆ ParseSuperTeamEvent()

void nim::ParseSuperTeamEvent ( int  rescode,
const std::string &  team_id,
const NIMNotificationId  notification_id,
const std::string &  team_event_json,
SuperTeamEvent team_event 
)

解析群组事件通知

Parameters
[in]rescode错误码
[in]team_id群组ID
[in]notification_id通知类型ID
[in]team_event_json通知内容(Json Value数据)
[out]team_event群组事件通知
Returns
void

◆ ParseSuperTeamInfoJson() [1/2]

bool nim::ParseSuperTeamInfoJson ( const nim_cpp_wrapper_util::Json::Value &  team_info_json,
SuperTeamInfo team_info 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据)
[out]team_info群组信息
Returns
void

◆ ParseSuperTeamInfoJson() [2/2]

bool nim::ParseSuperTeamInfoJson ( const std::string &  team_info_json,
SuperTeamInfo team_info 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据字符串)
[out]team_info群组信息
Returns
bool 解析成功或失败

◆ ParseSuperTeamInfosJson()

bool nim::ParseSuperTeamInfosJson ( const std::string &  team_infos_json,
std::list< SuperTeamInfo > &  team_infos 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据字符串)
[out]team_infos群组信息
Returns
bool 解析成功或失败

◆ ParseSuperTeamMemberPropertyJson() [1/2]

void nim::ParseSuperTeamMemberPropertyJson ( const nim_cpp_wrapper_util::Json::Value &  team_member_prop_json,
SuperTeamMemberProperty team_member_property 
)

解析群成员信息

Parameters
[in]team_member_prop_json群成员信息(Json Value数据)
[out]team_member_property群成员信息
Returns
void

◆ ParseSuperTeamMemberPropertyJson() [2/2]

bool nim::ParseSuperTeamMemberPropertyJson ( const std::string &  team_member_prop_json,
SuperTeamMemberProperty team_member_property 
)

解析群成员信息

Parameters
[in]team_member_prop_json群成员信息(Json Value数据字符串)
[out]team_member_property群成员信息
Returns
bool 解析成功或失败

◆ ParseSuperTeamMemberPropertysJson()

bool nim::ParseSuperTeamMemberPropertysJson ( const std::string &  team_member_props_json,
std::list< SuperTeamMemberProperty > &  team_member_propertys 
)

解析群成员信息

Parameters
[in]team_member_props_json群成员信息(Json Value数据字符串)
[out]team_member_propertys群成员信息
Returns
bool 解析成功或失败

◆ ParseSysMessage()

bool nim::ParseSysMessage ( const std::string &  sysmsg_json,
SysMessage msg 
)

解析系统消息或自定义通知

Parameters
[in]sysmsg_json系统消息或自定义通知(Json Value数据字符串)
[out]msg系统消息或自定义通知
Returns
bool 解析成功或失败

◆ ParseSysMessageContent()

void nim::ParseSysMessageContent ( const nim_cpp_wrapper_util::Json::Value &  content_json,
SysMessage msg 
)

解析系统消息或自定义通知的内容

Parameters
[in]content_json系统消息或自定义通知的内容(Json Value数据)
[out]msg系统消息或自定义通知
Returns
void

◆ ParseSysMessages()

bool nim::ParseSysMessages ( const std::string &  sysmsgs_json,
std::list< SysMessage > &  msgs,
int *  unread 
)

解析系统消息或自定义通知

Parameters
[in]sysmsgs_json系统消息或自定义通知(Json Value数据字符串)
[out]msgs系统消息或自定义通知
[out]unread当前总计的未读数
Returns
bool 解析成功或失败

◆ ParseTeamEvent()

void nim::ParseTeamEvent ( int  rescode,
const std::string &  team_id,
const NIMNotificationId  notification_id,
const std::string &  team_event_json,
TeamEvent team_event 
)

解析群组事件通知

Parameters
[in]rescode错误码
[in]team_id群组ID
[in]notification_id通知类型ID
[in]team_event_json通知内容(Json Value数据)
[out]team_event群组事件通知
Returns
void

◆ ParseTeamInfoJson() [1/2]

bool nim::ParseTeamInfoJson ( const nim_cpp_wrapper_util::Json::Value &  team_info_json,
TeamInfo team_info 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据)
[out]team_info群组信息
Returns
void

◆ ParseTeamInfoJson() [2/2]

bool nim::ParseTeamInfoJson ( const std::string &  team_info_json,
TeamInfo team_info 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据字符串)
[out]team_info群组信息
Returns
bool 解析成功或失败

◆ ParseTeamInfosJson()

bool nim::ParseTeamInfosJson ( const std::string &  team_infos_json,
std::list< TeamInfo > &  team_infos 
)

解析群组信息

Parameters
[in]team_info_json群组信息(Json Value数据字符串)
[out]team_infos群组信息
Returns
bool 解析成功或失败

◆ ParseTeamMemberPropertyJson() [1/2]

void nim::ParseTeamMemberPropertyJson ( const nim_cpp_wrapper_util::Json::Value &  team_member_prop_json,
TeamMemberProperty team_member_property 
)

解析群成员信息

Parameters
[in]team_member_prop_json群成员信息(Json Value数据)
[out]team_member_property群成员信息
Returns
void

◆ ParseTeamMemberPropertyJson() [2/2]

bool nim::ParseTeamMemberPropertyJson ( const std::string &  team_member_prop_json,
TeamMemberProperty team_member_property 
)

解析群成员信息

Parameters
[in]team_member_prop_json群成员信息(Json Value数据字符串)
[out]team_member_property群成员信息
Returns
bool 解析成功或失败

◆ ParseTeamMemberPropertysJson()

bool nim::ParseTeamMemberPropertysJson ( const std::string &  team_member_props_json,
std::list< TeamMemberProperty > &  team_member_propertys 
)

解析群成员信息

Parameters
[in]team_member_props_json群成员信息(Json Value数据字符串)
[out]team_member_propertys群成员信息
Returns
bool 解析成功或失败

◆ ParseUploadResult()

bool nim::ParseUploadResult ( const std::string &  url,
const std::string &  json,
UploadMediaResult res 
)

解析NOS上传结果

Parameters
[in]url上传结果地址
[in]jsonJson Value扩展数据
[out]res结果结构体
Returns
bool 解析成功 或失败

◆ StrListToJsonString()

bool nim::StrListToJsonString ( const std::list< std::string > &  list,
std::string &  out 
)

将一个string类型的list组装成一个Json Array

Parameters
[in]liststring类型的list
[out]outJson Array
Returns
bool 成功 或失败

◆ UnregNIMCallback()

void nim::UnregNIMCallback ( )

反注册NIM提供的所有回调

Returns
void 无返回值