1#ifndef V2_NIM_DEF_STRUCT_H
2#define V2_NIM_DEF_STRUCT_H
Definition ne_stl_continuous_container.h:15
Definition ne_stl_smart_ptr.h:31
Definition ne_stl_string.h:19
Definition ne_stl_map.h:15
Definition ne_stl_set.h:13
phmap::priv::Pair< const K, V > Pair
Definition ne_stl_map.h:11
Definition v2_nim_ai_service.hpp:4
V2NIMKickedOfflineReason
Definition v2_nim_def_enum.hpp:1223
@ V2NIM_KICKED_OFFLINE_REASON_CLIENT_EXCLUSIVE
多端登录互踢
Definition v2_nim_def_enum.hpp:1225
V2NIMTeamUpdateExtensionMode
Definition v2_nim_def_enum.hpp:1350
@ V2NIM_TEAM_UPDATE_EXTENSION_MODE_MANAGER
群主/管理员可以修改群组扩展字段
Definition v2_nim_def_enum.hpp:1352
V2NIMMessageAIRegenOpType
AI 消息重生操作类型
Definition v2_nim_def_enum.hpp:1690
@ V2NIM_MESSAGE_AI_REGEN_OP_UPDATE
更新消息,不会生成新消息,基于原有消息更新
Definition v2_nim_def_enum.hpp:1692
V2NIMMessageQuickCommentType
Definition v2_nim_def_enum.hpp:1133
@ V2NIM_MESSAGE_QUICK_COMMENT_TYPE_ADD
添加快捷评论
Definition v2_nim_def_enum.hpp:1135
V2NIMSignallingChannelType
Definition v2_nim_def_enum.hpp:1586
@ V2NIM_SIGNALLING_CHANNEL_TYPE_UNKNOWN
未知频道类型
Definition v2_nim_def_enum.hpp:1588
V2NIMTeamMemberRoleQueryType
Definition v2_nim_def_enum.hpp:1366
@ V2NIM_TEAM_MEMBER_ROLE_QUERY_TYPE_ALL
所有成员
Definition v2_nim_def_enum.hpp:1368
V2NIMFriendAddApplicationType
好友申请查询类型
Definition v2_nim_def_enum.hpp:1441
@ V2NIM_FRIEND_ADD_APPLICATION_TYPE_ALL
所有好友申请
Definition v2_nim_def_enum.hpp:1447
static const uint32_t V2NIM_DEFAULT_LOG_RESERVE_DAYS
Definition v2_nim_def_enum.hpp:1766
V2NIMProxyRequestMethod
Definition v2_nim_def_enum.hpp:1632
static const uint32_t V2NIM_DEFAULT_JOIN_ACTION_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1768
V2NIMChatroomMemberRole
Definition v2_nim_def_enum.hpp:1457
@ V2NIM_CHATROOM_MEMBER_ROLE_NORMAL
普通成员
Definition v2_nim_def_enum.hpp:1459
V2NIMMessageAttachmentUploadState
Definition v2_nim_def_enum.hpp:1001
@ V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_UNKNOWN
未知, 不存在附件或不需要上传的附件
Definition v2_nim_def_enum.hpp:1003
V2NIMMessageSource
Definition v2_nim_def_enum.hpp:981
@ V2NIM_MESSAGE_SOURCE_UNKNOWN
未知消息
Definition v2_nim_def_enum.hpp:983
V2NIMTeamUpdateInfoMode
Definition v2_nim_def_enum.hpp:1334
@ V2NIM_TEAM_UPDATE_INFO_MODE_MANAGER
群主/管理员可以修改群组资料
Definition v2_nim_def_enum.hpp:1336
V2NIMMessageRevokeType
Definition v2_nim_def_enum.hpp:1156
@ V2NIM_MESSAGE_REVOKE_TYPE_UNDEFINED
未定义
Definition v2_nim_def_enum.hpp:1158
V2NIMSortOrder
Definition v2_nim_def_enum.hpp:1140
@ V2NIM_SORT_ORDER_DESC
按时间降序排序
Definition v2_nim_def_enum.hpp:1142
V2NIMClientAntispamThesaurusMatchType
Definition v2_nim_def_enum.hpp:1297
@ V2NIM_CLIENT_ANTISPAM_THESAURUS_MATCH_TYPE_WORD
Definition v2_nim_def_enum.hpp:1298
V2NIMConnectionType
Definition v2_nim_def_enum.hpp:1744
@ V2NIM_CONNECTION_TYPE_UNKNOWN
未知类型
Definition v2_nim_def_enum.hpp:1746
V2NIMDataSyncLevel
Definition v2_nim_def_enum.hpp:1252
@ V2NIM_DATA_SYNC_LEVEL_FULL
完全同步
Definition v2_nim_def_enum.hpp:1254
V2NIMAIModelRoleType
Definition v2_nim_def_enum.hpp:1566
V2NIMAsymmetricEncryptionAlgorithm
Definition v2_nim_def_enum.hpp:885
@ V2NIM_ASYMMETRIC_ENCRYPTION_ALGORITHM_RSA
RSA
Definition v2_nim_def_enum.hpp:887
V2NIMClientAntispamOperateType
Definition v2_nim_def_enum.hpp:1286
@ V2NIM_CLIENT_ANTISPAM_OPERATE_NONE
无操作
Definition v2_nim_def_enum.hpp:1288
V2NIMErrorCode
NIM 错误码
Definition v2_nim_def_enum.hpp:34
@ V2NIM_ERROR_CODE_UNKNOWN
未知错误 / unknown error
Definition v2_nim_def_enum.hpp:36
@ V2NIM_ERROR_CODE_SUCCESS
请求成功 / success
Definition v2_nim_def_enum.hpp:38
static const uint32_t V2NIM_DEFAULT_LOGIN_TIMEOUT
Definition v2_nim_def_enum.hpp:1780
static const uint32_t V2NIM_DEFAULT_FRIEND_APPLICATION_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1769
V2NIMSearchStrategy
消息检索策略
Definition v2_nim_def_enum.hpp:1718
@ V2NIM_SEARCH_STRATEGY_FTS
表示使用 FTS 进行检索
Definition v2_nim_def_enum.hpp:1722
V2NIMFriendAddApplicationStatus
Definition v2_nim_def_enum.hpp:1420
@ V2NIM_FRIEND_ADD_APPLICATION_STATUS_INIT
未处理
Definition v2_nim_def_enum.hpp:1422
V2NIMAIModelType
Definition v2_nim_def_enum.hpp:1575
V2NIMChatroomQueueLevelMode
Definition v2_nim_def_enum.hpp:1450
@ V2NIM_CHATROOM_QUEUE_LEVEL_MODE_ANY
所有人都有权限操作
Definition v2_nim_def_enum.hpp:1452
V2NIMMessageAttachmentType
Definition v2_nim_def_enum.hpp:1533
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_UNIVERSAL
通用
Definition v2_nim_def_enum.hpp:1535
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_LOCATION
位置
Definition v2_nim_def_enum.hpp:1543
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_AUDIO
语音
Definition v2_nim_def_enum.hpp:1539
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_TEAM_NOTIFICATION
群通知
Definition v2_nim_def_enum.hpp:1545
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ENTER_NOTIFICATION
聊天室成员进入
Definition v2_nim_def_enum.hpp:1559
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_CHAT_BANNED_NOTIFICATION
聊天室禁言
Definition v2_nim_def_enum.hpp:1557
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_FILE
文件
Definition v2_nim_def_enum.hpp:1547
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CALL
话单
Definition v2_nim_def_enum.hpp:1549
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_QUEUE_NOTIFICATION
聊天室队列变更
Definition v2_nim_def_enum.hpp:1555
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ROLE_UPDATE_NOTIFICATION
聊天室成员角色变更
Definition v2_nim_def_enum.hpp:1561
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_VIDEO
视频
Definition v2_nim_def_enum.hpp:1541
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_NOTIFICATION
聊天室通知
Definition v2_nim_def_enum.hpp:1551
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CUSTOM
自定义消息
Definition v2_nim_def_enum.hpp:1563
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MESSAGE_REVOKE_NOTIFICATION
聊天室消息撤回
Definition v2_nim_def_enum.hpp:1553
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_IMAGE
图片
Definition v2_nim_def_enum.hpp:1537
V2NIMFCSAuthType
Definition v2_nim_def_enum.hpp:921
@ V2NIM_FCS_AUTH_TYPE_NONE
无鉴权
Definition v2_nim_def_enum.hpp:923
V2NIMTeamJoinActionStatus
Definition v2_nim_def_enum.hpp:1409
@ V2NIM_TEAM_JOIN_ACTION_STATUS_INIT
未处理
Definition v2_nim_def_enum.hpp:1411
V2NIMSearchDirection
消息查询方向
Definition v2_nim_def_enum.hpp:1710
@ V2NIM_SEARCH_DIRECTION_BACKWARD
表示时间从新到旧查询
Definition v2_nim_def_enum.hpp:1712
V2NIMSDKLogLevel
Definition v2_nim_def_enum.hpp:908
@ V2NIM_SDK_LOG_LEVEL_APP
应用
Definition v2_nim_def_enum.hpp:916
V2NIMAddressFamily
Definition v2_nim_def_enum.hpp:1756
@ V2NIM_ADDRESS_FAMILY_UNKNOWN
未知类型
Definition v2_nim_def_enum.hpp:1758
static const uint32_t V2NIM_DEFAULT_SEARCH_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1774
static const uint32_t V2NIM_DEFAULT_SEARCH_LOCAL_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1775
V2NIMAIModelStreamCallStatus
AI 流式消息状态
Definition v2_nim_def_enum.hpp:1698
@ V2NIM_AI_MODEL_STREAM_CALL_STATUS_NONE
非流式状态
Definition v2_nim_def_enum.hpp:1700
V2NIMLastMessageState
Definition v2_nim_def_enum.hpp:992
@ V2NIM_MESSAGE_STATE_DEFAULT
默认
Definition v2_nim_def_enum.hpp:994
static const uint32_t V2NIM_DEFAULT_CHATROOM_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1773
V2NIMTeamChatBannedMode
Definition v2_nim_def_enum.hpp:1341
@ V2NIM_TEAM_CHAT_BANNED_MODE_NONE
不禁言, 群组成员可以自由发言
Definition v2_nim_def_enum.hpp:1343
V2NIMTeamJoinActionType
Definition v2_nim_def_enum.hpp:1375
@ V2NIM_TEAM_JOIN_ACTION_TYPE_APPLICATION
申请入群
Definition v2_nim_def_enum.hpp:1377
V2NIMMessageAIStreamStatus
AI 流式消息状态
Definition v2_nim_def_enum.hpp:1662
@ V2NIM_MESSAGE_AI_STREAM_STATUS_NONE
非流式状态
Definition v2_nim_def_enum.hpp:1666
V2NIMTeamAgreeMode
Definition v2_nim_def_enum.hpp:1320
@ V2NIM_TEAM_AGREE_MODE_AUTH
需要被邀请人同意
Definition v2_nim_def_enum.hpp:1322
static const char * V2NIM_STORAGE_SCENE_NAME_DEFAULT_IM
Definition v2_nim_def_enum.hpp:1794
V2NIMChatroomKickedReason
Definition v2_nim_def_enum.hpp:1472
@ V2NIM_CHATROOM_KICKED_REASON_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:1474
V2NIMLoginClientType
Definition v2_nim_def_enum.hpp:1191
@ V2NIM_LOGIN_CLIENT_TYPE_UNKNOWN
未知类型
Definition v2_nim_def_enum.hpp:1193
V2NIMMessageClientAntispamOperatorType
Definition v2_nim_def_enum.hpp:1171
@ V2NIM_MESSAGE_CLIENT_ANTISPAM_OPERATOR_NONE
无操作
Definition v2_nim_def_enum.hpp:1173
V2NIMMessageType
Definition v2_nim_def_enum.hpp:945
@ V2NIM_MESSAGE_TYPE_TEXT
文本
Definition v2_nim_def_enum.hpp:947
V2NIMDownloadAttachmentType
Definition v2_nim_def_enum.hpp:1524
@ V2NIM_DOWNLOAD_ATTACHMENT_TYPE_SOURCE
原始资源,支持全部有附件的类型
Definition v2_nim_def_enum.hpp:1526
V2NIMTeamType
Definition v2_nim_def_enum.hpp:1302
@ V2NIM_TEAM_TYPE_NORMAL
高级群
Definition v2_nim_def_enum.hpp:1306
V2NIMDataSyncType
Definition v2_nim_def_enum.hpp:1259
@ V2NIM_DATA_SYNC_MAIN
同步主数据
Definition v2_nim_def_enum.hpp:1261
V2NIMFriendAddMode
Definition v2_nim_def_enum.hpp:1402
@ V2NIM_FRIEND_MODE_TYPE_ADD
直接添加对方为好友
Definition v2_nim_def_enum.hpp:1404
V2NIMSymmetricEncryptionAlgorithm
Definition v2_nim_def_enum.hpp:892
@ V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_RC4
RC4
Definition v2_nim_def_enum.hpp:894
static const uint32_t V2NIM_DEFAULT_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1767
V2NIMMessageStreamStatus
流式消息状态
Definition v2_nim_def_enum.hpp:1726
@ V2NIM_MESSAGE_STREAM_STATUS_NONE
非流式状态
Definition v2_nim_def_enum.hpp:1730
V2NIMSignallingEventType
信令频道事件类型
Definition v2_nim_def_enum.hpp:1598
static const uint32_t V2NIM_DEFAULT_LOG_MAX_SIZE
Definition v2_nim_def_enum.hpp:1765
static const uint32_t V2NIM_DEFAULT_SUBSCRIBE_DURATION
Definition v2_nim_def_enum.hpp:1781
V2NIMTeamInviteMode
Definition v2_nim_def_enum.hpp:1327
@ V2NIM_TEAM_INVITE_MODE_MANAGER
群主, 管理员可以邀请其他人入群
Definition v2_nim_def_enum.hpp:1329
V2NIMHandShakeType
Definition v2_nim_def_enum.hpp:878
@ V2NIM_HANDSHAKE_TYPE_DEFAULT
支持配置多种对称与非对称加密算法
Definition v2_nim_def_enum.hpp:880
V2NIMDataSyncState
Definition v2_nim_def_enum.hpp:1268
@ V2NIM_DATA_SYNC_STATE_WAITING
等待同步
Definition v2_nim_def_enum.hpp:1270
V2NIMMessageAIStatus
Definition v2_nim_def_enum.hpp:1147
@ V2NIM_MESSAGE_AI_STATUS_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:1149
static const uint64_t V2NIM_DEFAULT_UPLOAD_PART_SIZE
Definition v2_nim_def_enum.hpp:1785
V2NIMConversationType
Definition v2_nim_def_enum.hpp:934
@ V2NIM_CONVERSATION_TYPE_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:936
static const uint32_t V2NIM_DEFAULT_SEARCH_LOCAL_TEAM_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1776
static const uint32_t V2NIM_DEFAULT_COLLECTION_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1770
static const uint32_t V2NIM_DEFAULT_SEARCH_LOCAL_TEAM_MEMBER_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1777
V2NIMTeamJoinMode
Definition v2_nim_def_enum.hpp:1311
@ V2NIM_TEAM_JOIN_MODE_APPLY
需申请, 群主或管理同意后加入
Definition v2_nim_def_enum.hpp:1315
V2NIMMessageNotificationType
Definition v2_nim_def_enum.hpp:1012
@ V2NIM_MESSAGE_NOTIFICATION_TYPE_TEAM_INVITE
群拉人
Definition v2_nim_def_enum.hpp:1014
V2NIMClearHistoryMode
删除消息模式
Definition v2_nim_def_enum.hpp:1652
@ V2NIM_CLEAR_HISTORY_MODE_ALL
同时删除云端和本地
Definition v2_nim_def_enum.hpp:1654
V2NIMLoginAuthType
Definition v2_nim_def_enum.hpp:1182
@ V2NIM_LOGIN_AUTH_TYPE_DEFAULT
默认
Definition v2_nim_def_enum.hpp:1184
V2NIMQueryDirection
Definition v2_nim_def_enum.hpp:1126
@ V2NIM_QUERY_DIRECTION_DESC
按时间降序查询
Definition v2_nim_def_enum.hpp:1128
static const uint64_t DEFAULT_PROTOCOL_TIMEOUT
Definition v2_nim_def_enum.hpp:1783
V2NIMMessageSendingState
Definition v2_nim_def_enum.hpp:970
@ V2NIM_MESSAGE_SENDING_STATE_UNKNOWN
未知, 如果消息不是从这个端发送的
Definition v2_nim_def_enum.hpp:972
V2NIMChatroomMessageNotificationType
Definition v2_nim_def_enum.hpp:1059
@ V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_ENTER
成员进入聊天室
Definition v2_nim_def_enum.hpp:1061
V2NIMMessageAIStreamStopOpType
AI 流式消息停止操作类型
Definition v2_nim_def_enum.hpp:1680
@ V2NIM_MESSAGE_AI_STREAM_STOP_OP_DEFAULT
停止输出保持现状
Definition v2_nim_def_enum.hpp:1682
V2NIMIPProtocolVersion
Definition v2_nim_def_enum.hpp:869
@ V2NIM_IP_PROTOCOL_VERSION_IPV4
IPv4
Definition v2_nim_def_enum.hpp:873
static const uint32_t V2NIM_DEFAULT_TEAM_MEMBER_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1772
V2NIMSQLCipherVersion
Definition v2_nim_def_enum.hpp:901
@ V2NIM_SQLCIPHER_VERSION_4
SQLCipher 4
Definition v2_nim_def_enum.hpp:905
V2NIMMessagePinState
Definition v2_nim_def_enum.hpp:1117
@ V2NIM_MESSAGE_PIN_STEATE_NOT_PINNED
未 pin
Definition v2_nim_def_enum.hpp:1119
static const uint64_t DEFAULT_LINK_TIMEOUT
Definition v2_nim_def_enum.hpp:1782
V2NIMSearchKeywordMathType
搜索关键字匹配条件
Definition v2_nim_def_enum.hpp:1644
@ V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
或
Definition v2_nim_def_enum.hpp:1646
V2NIMChatroomQueueChangeType
Definition v2_nim_def_enum.hpp:1100
unsigned char bool
Definition stdbool.h:27
Definition ne_stl_optional.h:16
Definition ne_stl_bind.h:132
调用大模型的请求内容
Definition v2_nim_def_struct.hpp:640
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition v2_nim_def_struct.hpp:644
nstd::string msg
请求/响应的文本内容
Definition v2_nim_def_struct.hpp:642
Definition v2_nim_def_struct.hpp:647
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition v2_nim_def_struct.hpp:653
nstd::string msg
上下文的内容
Definition v2_nim_def_struct.hpp:651
V2NIMAIModelRoleType role
上下文内容的角色
Definition v2_nim_def_struct.hpp:649
Definition v2_nim_def_struct.hpp:898
nstd::optional< V2NIMAIModelCallContent > content
请求 AI 的回复
Definition v2_nim_def_struct.hpp:906
nstd::string accountId
数字人的账号 ID
Definition v2_nim_def_struct.hpp:902
nstd::string requestId
本次响应的标识
Definition v2_nim_def_struct.hpp:904
nstd::optional< nstd::vector< V2NIMAIRAGInfo > > aiRAGs
数字人回复内容的引用资源列表
Definition v2_nim_def_struct.hpp:908
uint32_t code
AI 响应的状态码
Definition v2_nim_def_struct.hpp:900
V2NIMAIModelStreamCallStatus aiStreamStatus
数字人流式响应状态
Definition v2_nim_def_struct.hpp:914
time_t timestamp
回复的时间戳
Definition v2_nim_def_struct.hpp:910
bool aiStream
是否是流式响应,默认 false
Definition v2_nim_def_struct.hpp:912
Definition v2_nim_def_struct.hpp:2364
nstd::optional< nstd::string > temperature
取值范围(0, 2), 用于控制随机性和多样性的程度。
Definition v2_nim_def_struct.hpp:2376
nstd::string model
具体大模型版本模型名
Definition v2_nim_def_struct.hpp:2366
nstd::optional< uint32_t > maxTokens
模型最大tokens数量
Definition v2_nim_def_struct.hpp:2372
nstd::optional< nstd::string > topP
取值范围(0, 1), 生成时,核采样方法的概率阈值。
Definition v2_nim_def_struct.hpp:2374
nstd::string prompt
提示词
Definition v2_nim_def_struct.hpp:2368
nstd::optional< nstd::vector< nstd::string > > promptKeys
提示词对应的变量
Definition v2_nim_def_struct.hpp:2370
Definition v2_nim_def_struct.hpp:656
nstd::optional< nstd::string > prompt
提示词
Definition v2_nim_def_struct.hpp:658
nstd::optional< int32_t > maxTokens
模型最大 tokens 数量
Definition v2_nim_def_struct.hpp:660
nstd::optional< double > temperature
取值范围 (0, 2), 用于控制随机性和多样性的程度。
Definition v2_nim_def_struct.hpp:664
nstd::optional< double > topP
取值范围 (0, 1), 生成时, 核采样方法的概率阈值。
Definition v2_nim_def_struct.hpp:662
透传协议流式分片信息
Definition v2_nim_def_struct.hpp:2926
time_t chunkTime
数字人流式回复当前分片时间
Definition v2_nim_def_struct.hpp:2930
int type
类型,当前仅支持 0 表示文本
Definition v2_nim_def_struct.hpp:2932
uint32_t index
分片序号,从 0 开始
Definition v2_nim_def_struct.hpp:2934
nstd::string content
数字人流式回复分片文本
Definition v2_nim_def_struct.hpp:2928
流式回复内容
Definition v2_nim_def_struct.hpp:2938
nstd::string msg
数字人流式回复分片组装好后的文本
Definition v2_nim_def_struct.hpp:2940
V2NIMAIModelStreamCallChunk lastChunk
数字人流式回复最近一个分片
Definition v2_nim_def_struct.hpp:2944
int type
类型,当前仅支持 0 表示文本
Definition v2_nim_def_struct.hpp:2942
发送透传的 AI 流式消息响应内容
Definition v2_nim_def_struct.hpp:2948
nstd::string requestId
本次响应的标识
Definition v2_nim_def_struct.hpp:2954
nstd::optional< nstd::vector< V2NIMAIRAGInfo > > aiRAGs
数字人回复内容的引用资源列表
Definition v2_nim_def_struct.hpp:2958
nstd::string accountId
数字人的账号 ID
Definition v2_nim_def_struct.hpp:2952
nstd::optional< V2NIMAIModelStreamCallContent > content
请求 AI 的回复内容
Definition v2_nim_def_struct.hpp:2956
int code
AI 响应的状态码
Definition v2_nim_def_struct.hpp:2950
time_t timestamp
分片的时间戳
Definition v2_nim_def_struct.hpp:2960
停止透传接口的 AI 流式回复
Definition v2_nim_def_struct.hpp:2964
nstd::string accountId
数字人账号 ID
Definition v2_nim_def_struct.hpp:2966
nstd::string requestId
请求 ID
Definition v2_nim_def_struct.hpp:2968
消息 AI RAG 信息
Definition v2_nim_def_struct.hpp:668
nstd::string title
引用资源的标题
Definition v2_nim_def_struct.hpp:678
nstd::string description
引用资源的描述
Definition v2_nim_def_struct.hpp:672
nstd::string name
引用资源的名称
Definition v2_nim_def_struct.hpp:670
time_t time
引用资源的时间
Definition v2_nim_def_struct.hpp:680
nstd::string icon
引用资源的图标
Definition v2_nim_def_struct.hpp:674
nstd::string url
引用资源的链接
Definition v2_nim_def_struct.hpp:676
Definition v2_nim_def_struct.hpp:2379
int aiModelType
数字人类型
Definition v2_nim_def_struct.hpp:2383
V2NIMAIModelConfig modelConfig
模型相关配置文件
Definition v2_nim_def_struct.hpp:2385
V2NIMAIModelType modelType
模型选择
Definition v2_nim_def_struct.hpp:2381
Definition v2_nim_def_struct.hpp:1249
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1255
uint32_t collectionType
收藏类型
Definition v2_nim_def_struct.hpp:1251
nstd::string collectionData
收藏数据
Definition v2_nim_def_struct.hpp:1253
nstd::optional< nstd::string > uniqueId
去重唯一 ID,如果 ID 相同,则不会新增收藏,只更新之前的收藏内容
Definition v2_nim_def_struct.hpp:1257
Definition v2_nim_def_struct.hpp:1735
nstd::string antispamBusinessId
易盾业务 ID
Definition v2_nim_def_struct.hpp:1737
Definition v2_nim_def_struct.hpp:112
bool disableAppNap
是否禁用 macOS 下的 App Nap 功能
Definition v2_nim_def_struct.hpp:134
bool reduceUnreadOnMessageRecall
收到撤回消息通知时是否减少指定会话的未读计数
Definition v2_nim_def_struct.hpp:140
uint32_t logMaxSize
日志文件大小上限, 单位字节,当文件超过最大文件大小时,SDK 会将已有日志文件对半裁剪,默认 50MB
Definition v2_nim_def_struct.hpp:126
uint32_t sdkType
Definition v2_nim_def_struct.hpp:148
nstd::string customTag
登录自定义信息, 最大 32 个字符
Definition v2_nim_def_struct.hpp:124
bool enableCloudConversation
是否使用云端会话和会话分组服务
Definition v2_nim_def_struct.hpp:118
uint32_t customClientType
自定义客户端类型
Definition v2_nim_def_struct.hpp:122
bool conversationSnapshot
查询会话时是否仅返回会话快照信息。设置为 true 有助于加快会话查询速度,减少构建完整会话信息耗时
Definition v2_nim_def_struct.hpp:142
nstd::optional< bool > teamNotificationBadge
群通知类消息是否计入未读数,默认以消息为准
Definition v2_nim_def_struct.hpp:138
uint32_t logReserveDays
日志保留天数
Definition v2_nim_def_struct.hpp:128
nstd::optional< nstd::string > compassDataEndpoint
云信指南针数据上报地址,为空则使用默认地址
Definition v2_nim_def_struct.hpp:144
bool enableCompass
云信指南针数据上报开关
Definition v2_nim_def_struct.hpp:136
bool useHttpdns
是否使用 httpdns
Definition v2_nim_def_struct.hpp:116
bool useHttps
是否使用 https
Definition v2_nim_def_struct.hpp:114
nstd::optional< nstd::string > abTestEndpoint
云信 A/B Test 策略获取地址,为空则使用默认地址
Definition v2_nim_def_struct.hpp:146
nstd::optional< nstd::string > customizeLogCollectionDirectory
自定义日志收集目录,当需要上报日志时可单独指定一个目录,SDK 会主动收集该目录下的所有文件
Definition v2_nim_def_struct.hpp:132
nstd::function< void(nstd::string log)> logCallback
Definition v2_nim_def_struct.hpp:150
bool enableCloudFriendAddApplication
是否使用云端好友申请托管服务
Definition v2_nim_def_struct.hpp:120
V2NIMSDKLogLevel sdkLogLevel
SDK日志级别
Definition v2_nim_def_struct.hpp:130
Definition v2_nim_def_struct.hpp:887
uint64_t id
广播通知 ID
Definition v2_nim_def_struct.hpp:889
uint64_t timestamp
广播通知时间戳
Definition v2_nim_def_struct.hpp:893
nstd::string content
广播通知内容
Definition v2_nim_def_struct.hpp:895
nstd::string senderId
广播通知发送者账号
Definition v2_nim_def_struct.hpp:891
聊天室自定义消息附件解析器
Definition v2_nim_def_struct.hpp:2321
virtual ~V2NIMChatRoomMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition v2_nim_def_struct.hpp:2100
nstd::vector< nstd::string > cdnUrls
Definition v2_nim_def_struct.hpp:2102
uint64_t pollingInterval
Definition v2_nim_def_struct.hpp:2104
uint64_t timestamp
Definition v2_nim_def_struct.hpp:2103
nstd::string decryptKey
Definition v2_nim_def_struct.hpp:2106
uint32_t decryptType
Definition v2_nim_def_struct.hpp:2105
bool enabled
Definition v2_nim_def_struct.hpp:2101
uint64_t pollingTimeout
Definition v2_nim_def_struct.hpp:2107
Definition v2_nim_def_struct.hpp:449
V2NIMChatroomChatBannedNotificationAttachment()
Definition v2_nim_def_struct.hpp:450
bool tempChatBanned
成员是否被临时禁言
Definition v2_nim_def_struct.hpp:454
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition v2_nim_def_struct.hpp:456
bool chatBanned
成员是否被禁言
Definition v2_nim_def_struct.hpp:452
Definition v2_nim_def_struct.hpp:187
nstd::string roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:191
uint32_t clientType
进入的终端类型
Definition v2_nim_def_struct.hpp:195
nstd::string roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:189
uint64_t enterTime
用户进入聊天室的时间点
Definition v2_nim_def_struct.hpp:193
Definition v2_nim_def_struct.hpp:2048
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:2054
V2NIMAntispamConfig antispamConfig
反垃圾配置信息
Definition v2_nim_def_struct.hpp:2074
nstd::string accountId
账号 ID
Definition v2_nim_def_struct.hpp:2050
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:2056
nstd::string token
静态 token
Definition v2_nim_def_struct.hpp:2052
nstd::optional< V2NIMChatroomLocationConfig > locationConfig
进入聊天室空间位置信息配置
Definition v2_nim_def_struct.hpp:2072
V2NIMChatroomLinkProvider linkProvider
获取聊天室 link 链接地址
Definition v2_nim_def_struct.hpp:2064
uint64_t timeout
登录超时, 单位毫秒
Definition v2_nim_def_struct.hpp:2058
bool anonymousMode
匿名模式
Definition v2_nim_def_struct.hpp:2062
V2NIMChatroomLoginOption loginOption
聊天室登录相关信息
Definition v2_nim_def_struct.hpp:2060
V2NIMChatroomTagConfig tagConfig
进入聊天室标签信息配置
Definition v2_nim_def_struct.hpp:2070
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition v2_nim_def_struct.hpp:2068
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:2066
Definition v2_nim_def_struct.hpp:2110
V2NIMChatroomInfo chatroom
聊天室信息
Definition v2_nim_def_struct.hpp:2112
V2NIMChatroomMember selfMember
用户信息
Definition v2_nim_def_struct.hpp:2114
Definition v2_nim_def_struct.hpp:2077
nstd::string serverExtension
聊天室扩展字段
Definition v2_nim_def_struct.hpp:2089
nstd::string announcement
聊天室公告
Definition v2_nim_def_struct.hpp:2083
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:2079
bool isValidRoom
聊天室是否有效
Definition v2_nim_def_struct.hpp:2087
bool chatBanned
聊天室禁言状态
Definition v2_nim_def_struct.hpp:2097
nstd::string roomName
聊天室名称
Definition v2_nim_def_struct.hpp:2081
nstd::string creatorAccountId
聊天室创建者账号 ID
Definition v2_nim_def_struct.hpp:2093
V2NIMChatroomQueueLevelMode queueLevelMode
聊天室队列操作权限模式
Definition v2_nim_def_struct.hpp:2091
uint32_t onlineUserCount
聊天室当前在线用户数量
Definition v2_nim_def_struct.hpp:2095
nstd::string liveUrl
视频直播拉流地址
Definition v2_nim_def_struct.hpp:2085
Definition v2_nim_def_struct.hpp:2117
nstd::string serverExtension
被踢扩展字段
Definition v2_nim_def_struct.hpp:2121
V2NIMChatroomKickedReason kickedReason
被踢原因
Definition v2_nim_def_struct.hpp:2119
Definition v2_nim_def_struct.hpp:2041
nstd::optional< double > distance
订阅的消息的距离
Definition v2_nim_def_struct.hpp:2045
V2NIMLocationInfo locationInfo
空间坐标信息
Definition v2_nim_def_struct.hpp:2043
Definition v2_nim_def_struct.hpp:2014
V2NIMRouteConfig routeConfig
路由配置(抄送)配置
Definition v2_nim_def_struct.hpp:2022
V2NIMLoginAuthType authType
认证模式
Definition v2_nim_def_struct.hpp:2016
V2NIMChatroomTokenProvider tokenProvider
token 获取回调
Definition v2_nim_def_struct.hpp:2018
V2NIMChatroomLoginExtensionProvider loginExtensionProvider
登陆扩展回调
Definition v2_nim_def_struct.hpp:2020
Definition v2_nim_def_struct.hpp:460
bool tempChatBanned
成员是否被临时禁言
Definition v2_nim_def_struct.hpp:465
bool chatBanned
成员是否被禁言
Definition v2_nim_def_struct.hpp:463
V2NIMChatroomMemberEnterNotificationAttachment()
Definition v2_nim_def_struct.hpp:461
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition v2_nim_def_struct.hpp:467
Definition v2_nim_def_struct.hpp:198
nstd::string accountId
成员账号 ID
Definition v2_nim_def_struct.hpp:202
nstd::string notifyTargetTags
登录登出通知标签
Definition v2_nim_def_struct.hpp:226
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:230
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:200
bool valid
是否有效
Definition v2_nim_def_struct.hpp:232
bool isOnline
用户是否在线
Definition v2_nim_def_struct.hpp:214
uint64_t enterTime
用户进入聊天室的时间点
Definition v2_nim_def_struct.hpp:228
nstd::vector< V2NIMChatroomEnterInfo > multiEnterInfo
多端登录信息
Definition v2_nim_def_struct.hpp:234
uint64_t tempChatBannedDuration
临时禁言时长, 单位秒
Definition v2_nim_def_struct.hpp:222
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:210
bool chatBanned
是否禁言
Definition v2_nim_def_struct.hpp:218
nstd::optional< nstd::string > serverExtension
聊天室成员扩展字段
Definition v2_nim_def_struct.hpp:212
nstd::vector< nstd::string > tags
登录标签
Definition v2_nim_def_struct.hpp:224
bool tempChatBanned
是否临时禁言
Definition v2_nim_def_struct.hpp:220
bool blocked
是否在黑名单中
Definition v2_nim_def_struct.hpp:216
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:208
nstd::optional< uint32_t > memberLevel
成员等级, 0 表示未设置
Definition v2_nim_def_struct.hpp:206
V2NIMChatroomMemberRole memberRole
聊天室成员角色
Definition v2_nim_def_struct.hpp:204
Definition v2_nim_def_struct.hpp:2228
nstd::vector< V2NIMChatroomMember > memberList
拉取的成员列表
Definition v2_nim_def_struct.hpp:2234
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:2232
nstd::string pageToken
下一次查询的偏移量
Definition v2_nim_def_struct.hpp:2230
Definition v2_nim_def_struct.hpp:2213
bool onlyBlocked
是否只返回黑名单成员
Definition v2_nim_def_struct.hpp:2217
nstd::string pageToken
偏移量
Definition v2_nim_def_struct.hpp:2223
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:2225
bool onlyOnline
是否只查询在线成员
Definition v2_nim_def_struct.hpp:2221
bool onlyChatBanned
是否只返回禁言用户
Definition v2_nim_def_struct.hpp:2219
nstd::vector< V2NIMChatroomMemberRole > memberRoles
需要查询的成员类型
Definition v2_nim_def_struct.hpp:2215
Definition v2_nim_def_struct.hpp:471
V2NIMChatroomMemberRoleUpdateAttachment()
Definition v2_nim_def_struct.hpp:472
V2NIMChatroomMember currentMember
当前的成员信息
Definition v2_nim_def_struct.hpp:476
V2NIMChatroomMemberRole previousRole
之前的角色类型
Definition v2_nim_def_struct.hpp:474
Definition v2_nim_def_struct.hpp:2248
nstd::optional< uint32_t > memberLevel
设置用户等级
Definition v2_nim_def_struct.hpp:2252
V2NIMChatroomMemberRole memberRole
设置的成员角色
Definition v2_nim_def_struct.hpp:2250
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition v2_nim_def_struct.hpp:2254
Definition v2_nim_def_struct.hpp:2135
bool highPriority
是否是高优先级消息
Definition v2_nim_def_struct.hpp:2139
bool historyEnabled
是否需要在服务端保存历史消息
Definition v2_nim_def_struct.hpp:2137
Definition v2_nim_def_struct.hpp:2142
nstd::string text
消息内容
Definition v2_nim_def_struct.hpp:2164
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:2172
V2NIMMessageSendingState sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:2158
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition v2_nim_def_struct.hpp:2168
V2NIMMessageType messageType
消息类型
Definition v2_nim_def_struct.hpp:2160
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:2174
uint32_t subType
消息子类型
Definition v2_nim_def_struct.hpp:2162
V2NIMLoginClientType senderClientType
消息发送方客户端类型
Definition v2_nim_def_struct.hpp:2146
V2NIMMessageAttachmentUploadState attachmentUploadState
附件上传状态
Definition v2_nim_def_struct.hpp:2156
V2NIMChatroomMessageConfig messageConfig
聊天室消息配置
Definition v2_nim_def_struct.hpp:2178
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:2166
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:2176
nstd::string messageClientId
客户端消息 ID
Definition v2_nim_def_struct.hpp:2144
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:2152
bool isSelf
消息发送者是否是自己
Definition v2_nim_def_struct.hpp:2154
V2NIMUserInfoConfig userInfoConfig
消息发送时的用户信息
Definition v2_nim_def_struct.hpp:2180
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition v2_nim_def_struct.hpp:2170
nstd::string senderId
消息发送者账号
Definition v2_nim_def_struct.hpp:2150
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition v2_nim_def_struct.hpp:2182
uint64_t createTime
消息时间, 单位毫秒
Definition v2_nim_def_struct.hpp:2148
Definition v2_nim_def_struct.hpp:2237
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:2245
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:2239
uint64_t beginTime
开始时间
Definition v2_nim_def_struct.hpp:2243
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition v2_nim_def_struct.hpp:2241
Definition v2_nim_def_struct.hpp:431
uint64_t messageTime
消息撤回时间
Definition v2_nim_def_struct.hpp:436
nstd::string messageClientId
消息撤回 ID
Definition v2_nim_def_struct.hpp:434
V2NIMChatroomMessageRevokeNotificationAttachment()
Definition v2_nim_def_struct.hpp:432
Definition v2_nim_def_struct.hpp:406
nstd::string operatorId
操作者
Definition v2_nim_def_struct.hpp:417
V2NIMChatroomNotificationAttachment()
Definition v2_nim_def_struct.hpp:407
nstd::optional< V2NIMChatroomMember > chatroomMember
Definition v2_nim_def_struct.hpp:427
nstd::vector< nstd::string > targetNicks
被操作成员的昵称列表
Definition v2_nim_def_struct.hpp:413
nstd::vector< nstd::string > tags
更新后的标签
Definition v2_nim_def_struct.hpp:423
nstd::optional< nstd::string > targetTag
被操作的标签
Definition v2_nim_def_struct.hpp:415
nstd::string operatorNick
操作者昵称
Definition v2_nim_def_struct.hpp:419
nstd::optional< nstd::string > notificationExtension
扩展字段
Definition v2_nim_def_struct.hpp:421
nstd::vector< nstd::string > targetIds
被操作的成员账号列表
Definition v2_nim_def_struct.hpp:411
V2NIMChatroomMessageNotificationType type
通知类型
Definition v2_nim_def_struct.hpp:409
nstd::optional< V2NIMChatroomUpdateParams > chatroomUpdateParams
Definition v2_nim_def_struct.hpp:425
聊天室队列元素
Definition v2_nim_def_struct.hpp:296
nstd::string value
元素的值
Definition v2_nim_def_struct.hpp:300
nstd::string key
元素的唯一 key,中文不建议超过 64 个字符,英文不建议超过 128 个字符
Definition v2_nim_def_struct.hpp:298
nstd::optional< nstd::string > nick
该元素所属于的账号的昵称
Definition v2_nim_def_struct.hpp:304
nstd::optional< nstd::string > extension
其他的扩展字段 JSON String
Definition v2_nim_def_struct.hpp:306
nstd::optional< nstd::string > accountId
该元素所属于的账号
Definition v2_nim_def_struct.hpp:302
Definition v2_nim_def_struct.hpp:440
nstd::vector< V2NIMChatroomQueueElement > elements
队列变更的内容
Definition v2_nim_def_struct.hpp:443
V2NIMChatroomQueueNotificationAttachment()
Definition v2_nim_def_struct.hpp:441
V2NIMChatroomQueueChangeType queueChangeType
队列更新类型
Definition v2_nim_def_struct.hpp:445
Definition v2_nim_def_struct.hpp:2339
bool transient
元素是否瞬态的
Definition v2_nim_def_struct.hpp:2345
nstd::optional< nstd::string > elementOwnerAccountId
元素属于的账号
Definition v2_nim_def_struct.hpp:2347
nstd::string elementValue
元素的值
Definition v2_nim_def_struct.hpp:2343
nstd::string elementKey
元素的唯一key
Definition v2_nim_def_struct.hpp:2341
Definition v2_nim_def_struct.hpp:2257
bool persistence
更新信息持久化
Definition v2_nim_def_struct.hpp:2269
nstd::optional< nstd::string > roomNick
聊天室显示的昵称
Definition v2_nim_def_struct.hpp:2259
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:2267
nstd::optional< nstd::string > roomAvatar
聊天室显示的头像
Definition v2_nim_def_struct.hpp:2261
nstd::optional< nstd::string > serverExtension
成员扩展字段
Definition v2_nim_def_struct.hpp:2263
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:2265
Definition v2_nim_def_struct.hpp:2025
nstd::vector< nstd::string > tags
登陆标签
Definition v2_nim_def_struct.hpp:2027
nstd::string notifyTargetTags
登录登出通知标签
Definition v2_nim_def_struct.hpp:2029
Definition v2_nim_def_struct.hpp:2296
nstd::string tag
标签
Definition v2_nim_def_struct.hpp:2298
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:2302
nstd::string pageToken
偏移量
Definition v2_nim_def_struct.hpp:2300
Definition v2_nim_def_struct.hpp:2305
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition v2_nim_def_struct.hpp:2309
V2NIMQueryDirection direction
查询方向
Definition v2_nim_def_struct.hpp:2317
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:2315
uint64_t beginTime
查询起始时间
Definition v2_nim_def_struct.hpp:2311
nstd::vector< nstd::string > tags
查询的标签
Definition v2_nim_def_struct.hpp:2307
uint64_t endTime
查询结束时间
Definition v2_nim_def_struct.hpp:2313
Definition v2_nim_def_struct.hpp:2272
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:2282
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:2280
uint64_t duration
禁言时长, 单位秒
Definition v2_nim_def_struct.hpp:2278
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:2276
nstd::string targetTag
禁言的 tag
Definition v2_nim_def_struct.hpp:2274
Definition v2_nim_def_struct.hpp:237
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:247
nstd::optional< nstd::string > roomName
聊天室名称
Definition v2_nim_def_struct.hpp:239
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:249
nstd::optional< nstd::string > serverExtension
聊天室扩展字段
Definition v2_nim_def_struct.hpp:245
nstd::optional< V2NIMChatroomQueueLevelMode > queueLevelMode
Definition v2_nim_def_struct.hpp:251
nstd::optional< nstd::string > announcement
聊天室公告
Definition v2_nim_def_struct.hpp:241
nstd::optional< nstd::string > liveUrl
聊天室直播地址
Definition v2_nim_def_struct.hpp:243
Definition v2_nim_def_struct.hpp:1166
bool deleteRoam
是否同步删除漫游消息, 默认删除, 该字段只 P2P 时有效
Definition v2_nim_def_struct.hpp:1170
bool onlineSync
是否多端同步, 默认不同步
Definition v2_nim_def_struct.hpp:1172
V2NIMClearHistoryMode clearMode
清理消息方式,默认为 V2NIM_CLEAR_HISTORY_MODE_ALL,表示删除云端和本地
Definition v2_nim_def_struct.hpp:1176
nstd::optional< nstd::string > serverExtension
扩展字段, 多端同步时会同步到其它端
Definition v2_nim_def_struct.hpp:1174
nstd::string conversationId
需要清空消息的对应的会话 ID
Definition v2_nim_def_struct.hpp:1168
Definition v2_nim_def_struct.hpp:1223
uint64_t deleteTime
被删除的时间
Definition v2_nim_def_struct.hpp:1227
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:1225
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition v2_nim_def_struct.hpp:1229
Definition v2_nim_def_struct.hpp:1050
V2NIMClientAntispamOperateType operateType
客户端反垃圾文本命中后操作类型
Definition v2_nim_def_struct.hpp:1052
nstd::string replacedText
处理后的文本内容
Definition v2_nim_def_struct.hpp:1054
Definition v2_nim_def_struct.hpp:2333
nstd::vector< V2NIMClientAntispamThesaurusItem > items
Definition v2_nim_def_struct.hpp:2336
nstd::string name
Definition v2_nim_def_struct.hpp:2334
nstd::string config
Definition v2_nim_def_struct.hpp:2335
Definition v2_nim_def_struct.hpp:2326
nstd::string config
Definition v2_nim_def_struct.hpp:2330
nstd::string key
Definition v2_nim_def_struct.hpp:2327
V2NIMClientAntispamThesaurusMatchType matchType
Definition v2_nim_def_struct.hpp:2328
V2NIMClientAntispamOperateType operateType
Definition v2_nim_def_struct.hpp:2329
消息查询结果
Definition v2_nim_def_struct.hpp:1141
nstd::optional< V2NIMMessage > anchorMessage
锚点消息,根据锚点消息查询,不包含该消息
Definition v2_nim_def_struct.hpp:1155
time_t endTime
消息查询结束时间
Definition v2_nim_def_struct.hpp:1147
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1151
time_t beginTime
消息查询开始时间,小于等于 endTime
Definition v2_nim_def_struct.hpp:1145
nstd::string conversationId
消息所属会话 ID
Definition v2_nim_def_struct.hpp:1143
uint32_t limit
每次查询条数,默认 50
Definition v2_nim_def_struct.hpp:1149
nstd::vector< V2NIMMessageType > messageTypes
根据消息类型查询会话,不指定或空列表,则表示查询所有消息类型
Definition v2_nim_def_struct.hpp:1153
Definition v2_nim_def_struct.hpp:1232
uint32_t collectionType
收藏索引
Definition v2_nim_def_struct.hpp:1236
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1240
nstd::optional< nstd::string > uniqueId
去重唯一 ID
Definition v2_nim_def_struct.hpp:1242
nstd::string collectionId
收藏信息服务端 ID
Definition v2_nim_def_struct.hpp:1234
nstd::string collectionData
收藏数据
Definition v2_nim_def_struct.hpp:1238
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:1244
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:1246
Definition v2_nim_def_struct.hpp:1275
nstd::vector< V2NIMCollection > collectionList
本次分页查询返回的收藏列表
Definition v2_nim_def_struct.hpp:1279
uint32_t totalCount
总收藏条数
Definition v2_nim_def_struct.hpp:1277
Definition v2_nim_def_struct.hpp:1260
uint64_t endTime
查询结束时间区间, 闭区间, 0 表示当前时间
Definition v2_nim_def_struct.hpp:1264
nstd::optional< V2NIMCollection > anchorCollection
查询锚点
Definition v2_nim_def_struct.hpp:1266
V2NIMQueryDirection direction
查询方向
Definition v2_nim_def_struct.hpp:1268
uint32_t limit
每次查询收藏条数
Definition v2_nim_def_struct.hpp:1270
uint64_t beginTime
查询开始时间区间, 闭区间
Definition v2_nim_def_struct.hpp:1262
uint32_t collectionType
收藏类型
Definition v2_nim_def_struct.hpp:1272
Definition v2_nim_def_struct.hpp:3002
V2NIMConnectionType type
地址类型 V2NIMConnectionType }
Definition v2_nim_def_struct.hpp:3004
nstd::string ipAddress
一个域名可能解析出多个 IP 地址,最终选择建连的地址
Definition v2_nim_def_struct.hpp:3010
uint16_t port
目标端口
Definition v2_nim_def_struct.hpp:3012
V2NIMErrorCode code
错误码
Definition v2_nim_def_struct.hpp:3014
nstd::string hostname
目标域名,有可能是 IP 地址与 ipAddress 一致
Definition v2_nim_def_struct.hpp:3008
V2NIMAddressFamily family
地址协议族 V2NIMAddressFamily }
Definition v2_nim_def_struct.hpp:3006
Definition v2_nim_def_struct.hpp:1456
bool ignoreMuted
过滤免打扰会话
Definition v2_nim_def_struct.hpp:1462
nstd::string conversationGroupId
过滤指定分组的会话, nullopt: 不过滤会话分组
Definition v2_nim_def_struct.hpp:1460
nstd::set< V2NIMConversationType > conversationTypes
过滤指定对话类型, empty: 不限制会话类型
Definition v2_nim_def_struct.hpp:1458
Definition v2_nim_def_struct.hpp:1465
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:1475
nstd::string name
会话分组名称
Definition v2_nim_def_struct.hpp:1469
nstd::string groupId
会话分组 ID
Definition v2_nim_def_struct.hpp:1467
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1471
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:1473
Definition v2_nim_def_struct.hpp:1478
nstd::vector< V2NIMConversationOperationResult > failedList
失败的会话列表
Definition v2_nim_def_struct.hpp:1482
V2NIMConversationGroup group
会话分组信息
Definition v2_nim_def_struct.hpp:1480
Definition v2_nim_def_struct.hpp:1393
nstd::optional< nstd::string > localExtension
本地扩展信息
Definition v2_nim_def_struct.hpp:1409
nstd::vector< nstd::string > groupIds
会话分组 ID 列表
Definition v2_nim_def_struct.hpp:1407
V2NIMConversationType type
会话类型
Definition v2_nim_def_struct.hpp:1397
uint64_t updateTime
会话更新时间
Definition v2_nim_def_struct.hpp:1421
nstd::optional< nstd::string > name
会话名称
Definition v2_nim_def_struct.hpp:1399
uint64_t sortOrder
会话排序时间
Definition v2_nim_def_struct.hpp:1417
uint64_t createTime
会话创建时间
Definition v2_nim_def_struct.hpp:1419
nstd::optional< V2NIMLastMessage > lastMessage
最后一条消息
Definition v2_nim_def_struct.hpp:1413
nstd::optional< nstd::string > serverExtension
服务端扩展信息
Definition v2_nim_def_struct.hpp:1411
nstd::string conversationId
会话标识
Definition v2_nim_def_struct.hpp:1395
uint32_t unreadCount
未读计数
Definition v2_nim_def_struct.hpp:1415
nstd::optional< nstd::string > avatar
会话头像
Definition v2_nim_def_struct.hpp:1401
uint64_t lastReadTime
会话已读时间戳,多端同步,该时间之前的消息均为已读
Definition v2_nim_def_struct.hpp:1423
bool stickTop
置顶
Definition v2_nim_def_struct.hpp:1405
bool mute
免打扰
Definition v2_nim_def_struct.hpp:1403
Definition v2_nim_def_struct.hpp:1435
nstd::string conversationId
会话标识
Definition v2_nim_def_struct.hpp:1437
V2NIMError error
错误
Definition v2_nim_def_struct.hpp:1439
Definition v2_nim_def_struct.hpp:1447
bool onlyUnread
false: 查询所有会话, true: 查询包含未读的会话
Definition v2_nim_def_struct.hpp:1453
nstd::vector< V2NIMConversationType > conversationTypes
查询指定会话类型, empty: 不限制会话类型
Definition v2_nim_def_struct.hpp:1449
nstd::optional< nstd::vector< nstd::string > > conversationGroupIds
查询指定分组的会话, null: 查询所有分组, empty: 查询未分组的会话
Definition v2_nim_def_struct.hpp:1451
Definition v2_nim_def_struct.hpp:1426
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:1430
uint64_t offset
下一次拉取的偏移
Definition v2_nim_def_struct.hpp:1428
nstd::vector< V2NIMConversation > conversationList
会话列表
Definition v2_nim_def_struct.hpp:1432
Definition v2_nim_def_struct.hpp:1442
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1444
Definition v2_nim_def_struct.hpp:1654
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition v2_nim_def_struct.hpp:1678
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:1664
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition v2_nim_def_struct.hpp:1676
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition v2_nim_def_struct.hpp:1670
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:1660
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:1666
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition v2_nim_def_struct.hpp:1674
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition v2_nim_def_struct.hpp:1672
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1658
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:1680
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:1662
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1668
nstd::string name
群组名称
Definition v2_nim_def_struct.hpp:1656
Definition v2_nim_def_struct.hpp:1696
V2NIMTeam team
被创建的群组信息
Definition v2_nim_def_struct.hpp:1698
nstd::vector< nstd::string > failedList
被邀请成员失败列表
Definition v2_nim_def_struct.hpp:1700
Definition v2_nim_def_struct.hpp:866
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:882
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:884
nstd::string receiverId
通知接收者账号
Definition v2_nim_def_struct.hpp:870
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition v2_nim_def_struct.hpp:880
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition v2_nim_def_struct.hpp:878
nstd::string senderId
通知发送者账号
Definition v2_nim_def_struct.hpp:868
uint64_t timestamp
客户设置时间戳
Definition v2_nim_def_struct.hpp:874
nstd::string content
通知内容
Definition v2_nim_def_struct.hpp:876
V2NIMConversationType conversationType
通知所属会话类型
Definition v2_nim_def_struct.hpp:872
自定义用户状态参数
Definition v2_nim_def_struct.hpp:2685
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition v2_nim_def_struct.hpp:2691
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 7 天
Definition v2_nim_def_struct.hpp:2689
uint32_t statusType
自定义设置值 10000 以上,不包括 10000,10000 以内为内部预定义值。小于 10000 将返回参数错误
Definition v2_nim_def_struct.hpp:2687
bool multiSync
用户发布状态时是否需要多端同步
Definition v2_nim_def_struct.hpp:2695
bool onlineOnly
用户发布状态时是否只广播给在线的订阅者
Definition v2_nim_def_struct.hpp:2693
自定义用户状态发布结果
Definition v2_nim_def_struct.hpp:2699
nstd::string serverId
服务器针对该状态事件生成的 ID
Definition v2_nim_def_struct.hpp:2703
time_t publishTime
用户状态发布时的时间
Definition v2_nim_def_struct.hpp:2705
nstd::string uniqueId
发布自定义用户状态时,内部生成的唯一 ID
Definition v2_nim_def_struct.hpp:2701
Definition v2_nim_def_struct.hpp:1357
V2NIMDataSyncType type
数据同步类型
Definition v2_nim_def_struct.hpp:1359
V2NIMDataSyncState state
数据同步状态
Definition v2_nim_def_struct.hpp:1361
数据库信息
Definition v2_nim_def_struct.hpp:2992
uint64_t size
数据库大小字节
Definition v2_nim_def_struct.hpp:2998
nstd::string path
数据库路径
Definition v2_nim_def_struct.hpp:2994
nstd::string name
数据库名称
Definition v2_nim_def_struct.hpp:2996
Definition v2_nim_def_struct.hpp:97
V2NIMSQLCipherVersion sqlcipherVersion
SQLCipher 版本, 仅 macOS / Linux 平台有效
Definition v2_nim_def_struct.hpp:107
bool enableRestore
是否开启用户数据恢复(本地)功能
Definition v2_nim_def_struct.hpp:103
uint64_t backupIntervalTimeInSeconds
数据库备份间隔时间(秒),为 0 表示使用默认值(3 天备份一次)
Definition v2_nim_def_struct.hpp:109
nstd::string encryptionKey
数据库加密密钥
Definition v2_nim_def_struct.hpp:99
nstd::string backupFolder
用户数据备份(本地)目录, 缺省在数据文件所在目录创建一个dbFile.back目录
Definition v2_nim_def_struct.hpp:105
bool enableBackup
是否开启用户数据备份(本地)功能
Definition v2_nim_def_struct.hpp:101
Definition v2_nim_def_struct.hpp:1999
bool dndOn
免打扰是否开启
Definition v2_nim_def_struct.hpp:2003
uint32_t fromM
如果开启免打扰,开始分钟数 (Integer)
Definition v2_nim_def_struct.hpp:2007
uint32_t toM
如果开启免打扰,截止分钟数 (Integer)
Definition v2_nim_def_struct.hpp:2011
uint32_t toH
如果开启免打扰,截止小时数 (Integer)
Definition v2_nim_def_struct.hpp:2009
uint32_t fromH
如果开启免打扰,开始小时数 (Integer)
Definition v2_nim_def_struct.hpp:2005
bool showDetail
是否显示详情
Definition v2_nim_def_struct.hpp:2001
下载消息附件资源请求参数
Definition v2_nim_def_struct.hpp:2389
nstd::optional< nstd::string > saveAs
附件保存路径,如未指定 SDK 将下载到登录用户缓存目录,如指定该参数则以指定的路径为准
Definition v2_nim_def_struct.hpp:2399
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件信息
Definition v2_nim_def_struct.hpp:2391
nstd::optional< nstd::string > messageClientId
消息客户端 ID,如果指定了该参数将下载完成后的本地附件保存路径更新到消息数据库中,下一次查询时将直接返回对应的路径
Definition v2_nim_def_struct.hpp:2397
V2NIMDownloadAttachmentType type
要下载附件的类型 V2NIMDownloadAttachmentType
Definition v2_nim_def_struct.hpp:2393
nstd::optional< V2NIMSize > thumbSize
如果下载的是缩略图或者视频封面,通过该参数指定缩略图大小或视频封面大小
Definition v2_nim_def_struct.hpp:2395
Definition v2_nim_def_struct.hpp:7
uint32_t code
错误码, 详见 V2NIMErrorCode
Definition v2_nim_def_struct.hpp:9
nstd::string & operator[](const nstd::string &key)
Definition v2_nim_internal.hpp:22
nstd::map< nstd::string, nstd::string > detail
错误详情
Definition v2_nim_def_struct.hpp:13
nstd::string desc
错误描述
Definition v2_nim_def_struct.hpp:11
Definition v2_nim_def_struct.hpp:53
nstd::string customAuthUA
自定义鉴权 User Agent 信息
Definition v2_nim_def_struct.hpp:59
nstd::string customAuthRefer
自定义鉴权 Refer 信息
Definition v2_nim_def_struct.hpp:57
V2NIMFCSAuthType fcsAuthType
融合存储认证类型
Definition v2_nim_def_struct.hpp:55
Definition v2_nim_def_struct.hpp:1892
nstd::optional< nstd::string > postscript
最新附言
Definition v2_nim_def_struct.hpp:1902
nstd::string applicantAccountId
申请者账号
Definition v2_nim_def_struct.hpp:1896
bool read
是否已读
Definition v2_nim_def_struct.hpp:1910
nstd::string operatorAccountId
操作者账号
Definition v2_nim_def_struct.hpp:1900
uint64_t timestamp
时间
Definition v2_nim_def_struct.hpp:1906
uint64_t updateTimestamp
更新时间
Definition v2_nim_def_struct.hpp:1908
nstd::vector< V2NIMPostscript > postscriptHistory
附言历史
Definition v2_nim_def_struct.hpp:1912
nstd::string recipientAccountId
被申请者账号
Definition v2_nim_def_struct.hpp:1898
V2NIMFriendAddApplicationStatus status
状态
Definition v2_nim_def_struct.hpp:1904
nstd::string serverId
申请记录 ID
Definition v2_nim_def_struct.hpp:1894
Definition v2_nim_def_struct.hpp:1981
uint64_t offset
分页偏移
Definition v2_nim_def_struct.hpp:1983
nstd::vector< V2NIMFriendAddApplicationStatus > status
查询状态
Definition v2_nim_def_struct.hpp:1987
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1985
Definition v2_nim_def_struct.hpp:1990
nstd::vector< V2NIMFriendAddApplication > infos
查询返回的列表
Definition v2_nim_def_struct.hpp:1992
bool finished
分页结束
Definition v2_nim_def_struct.hpp:1996
uint64_t offset
下一次的偏移量
Definition v2_nim_def_struct.hpp:1994
Definition v2_nim_def_struct.hpp:1875
V2NIMFriendAddMode addMode
添加好友模式
Definition v2_nim_def_struct.hpp:1877
nstd::optional< nstd::string > postscript
添加/申请添加好友的附言
Definition v2_nim_def_struct.hpp:1879
清除好友申请选项
Definition v2_nim_def_struct.hpp:1937
int64_t timestamp
时间戳,默认当前时间戳,会删除这个时间之前的所有记录
Definition v2_nim_def_struct.hpp:1939
V2NIMFriendAddApplicationType type
好友申请类型,默认全部
Definition v2_nim_def_struct.hpp:1941
Definition v2_nim_def_struct.hpp:1915
bool deleteAlias
是否删除备注
Definition v2_nim_def_struct.hpp:1917
Definition v2_nim_def_struct.hpp:1854
nstd::optional< uint64_t > createTime
创建时间
Definition v2_nim_def_struct.hpp:1864
nstd::optional< uint32_t > flag
Definition v2_nim_def_struct.hpp:1870
nstd::optional< nstd::string > serverExtension
好友扩展字段
Definition v2_nim_def_struct.hpp:1860
nstd::optional< nstd::string > alias
好友备注
Definition v2_nim_def_struct.hpp:1858
V2NIMUser userProfile
好友对应的用户信息
Definition v2_nim_def_struct.hpp:1868
nstd::string accountId
好友账号
Definition v2_nim_def_struct.hpp:1856
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1866
nstd::optional< nstd::string > customerExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1862
nstd::optional< uint32_t > beflag
Definition v2_nim_def_struct.hpp:1872
Definition v2_nim_def_struct.hpp:1927
bool searchAccountId
是否搜索用户账号
Definition v2_nim_def_struct.hpp:1933
bool searchAlias
是否搜索用户昵称
Definition v2_nim_def_struct.hpp:1931
nstd::string keyword
搜索关键字, 默认搜索好友备注, 可以指定是否同时搜索用户账号
Definition v2_nim_def_struct.hpp:1929
Definition v2_nim_def_struct.hpp:1920
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1924
nstd::optional< nstd::string > alias
别名
Definition v2_nim_def_struct.hpp:1922
Definition v2_nim_def_struct.hpp:161
V2NIMBasicOption basicOption
基础配置
Definition v2_nim_def_struct.hpp:167
V2NIMFCSOption fcsOption
融合存储配置
Definition v2_nim_def_struct.hpp:173
nstd::optional< V2NIMPrivateServerOption > privateServerOption
私有化配置
Definition v2_nim_def_struct.hpp:177
V2NIMRouteConfig routeConfig
路由配置(抄送)配置
Definition v2_nim_def_struct.hpp:175
V2NIMLinkOption linkOption
连接相关配置
Definition v2_nim_def_struct.hpp:169
nstd::string appDataPath
app 数据目录, 为空则使用默认目录
Definition v2_nim_def_struct.hpp:165
V2NIMDatabaseOption databaseOption
数据库配置
Definition v2_nim_def_struct.hpp:171
nstd::string appkey
app key
Definition v2_nim_def_struct.hpp:163
Definition v2_nim_def_struct.hpp:1346
V2NIMKickedOfflineReason reason
原因
Definition v2_nim_def_struct.hpp:1348
V2NIMLoginClientType clientType
客户端类型
Definition v2_nim_def_struct.hpp:1352
uint32_t customClientType
自定义客户端类型
Definition v2_nim_def_struct.hpp:1354
nstd::string reasonDesc
说明
Definition v2_nim_def_struct.hpp:1350
Definition v2_nim_def_struct.hpp:1364
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:1374
nstd::optional< V2NIMMessageRefer > messageRefer
最后一条消息引用
Definition v2_nim_def_struct.hpp:1368
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition v2_nim_def_struct.hpp:1390
nstd::optional< V2NIMMessageRevokeType > revokeType
消息撤回类型
Definition v2_nim_def_struct.hpp:1382
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件
Definition v2_nim_def_struct.hpp:1378
nstd::optional< uint32_t > subType
消息子类型
Definition v2_nim_def_struct.hpp:1372
nstd::optional< V2NIMMessageType > messageType
最后一条消息类型
Definition v2_nim_def_struct.hpp:1370
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:1388
nstd::string text
消息文本内容或撤回附言
Definition v2_nim_def_struct.hpp:1376
nstd::optional< nstd::string > senderId
发送者账号信息
Definition v2_nim_def_struct.hpp:1384
nstd::optional< nstd::string > revokeAccountId
消息撤回者账号
Definition v2_nim_def_struct.hpp:1380
nstd::optional< nstd::string > senderName
如果是正常接收的消息,则显示发送者昵称。如果是被撤回的消息,则显示消息撤回者昵称。显示规则:如果是好友,则返回好友备注,否则如果是群成员,返回群成员昵称,否则返回用户昵称
Definition v2_nim_def_struct.hpp:1386
V2NIMLastMessageState lastMessageState
最后一条消息状态
Definition v2_nim_def_struct.hpp:1366
Definition v2_nim_def_struct.hpp:38
uint64_t protocolTimeout
协议超时, 单位毫秒
Definition v2_nim_def_struct.hpp:42
V2NIMSymmetricEncryptionAlgorithm symmetricEncryptionAlgorithm
对称加密通信加密算法
Definition v2_nim_def_struct.hpp:48
V2NIMHandShakeType handShakeType
握手协议版本,默认使用最新版本
Definition v2_nim_def_struct.hpp:44
V2NIMTransportLayerSecurityOption tlsOption
TLS 选项,目前仅在使用 WebSocket 链接时使用
Definition v2_nim_def_struct.hpp:50
uint64_t linkTimeout
连接超时, 单位毫秒
Definition v2_nim_def_struct.hpp:40
V2NIMAsymmetricEncryptionAlgorithm asymmetricEncryptionAlgorithm
非对称加密"交换密钥"协议加密算法
Definition v2_nim_def_struct.hpp:46
本地会话过滤条件
Definition v2_nim_def_struct.hpp:2901
nstd::vector< V2NIMConversationType > conversationTypes
过滤指定会话类型,留空表示不限制会话类型
Definition v2_nim_def_struct.hpp:2903
bool ignoreMuted
是否过滤免打扰的会话类型,true 表示过滤免打扰的会话,false 表示不过滤
Definition v2_nim_def_struct.hpp:2905
本地会话信息
Definition v2_nim_def_struct.hpp:2842
uint64_t createTime
会话创建时间戳
Definition v2_nim_def_struct.hpp:2877
uint64_t sortOrder
Definition v2_nim_def_struct.hpp:2875
uint32_t unreadCount
会话未读消息计数
Definition v2_nim_def_struct.hpp:2872
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:2844
nstd::optional< nstd::string > localExtension
会话本地扩展字段,不会多端同步
Definition v2_nim_def_struct.hpp:2868
uint64_t updateTime
会话更新时间戳
Definition v2_nim_def_struct.hpp:2879
nstd::optional< nstd::string > avatar
Definition v2_nim_def_struct.hpp:2859
nstd::optional< V2NIMLastMessage > lastMessage
会话所属的最近一条消息
Definition v2_nim_def_struct.hpp:2870
nstd::optional< nstd::string > name
Definition v2_nim_def_struct.hpp:2851
bool stickTop
会话置顶状态
Definition v2_nim_def_struct.hpp:2866
bool mute
Definition v2_nim_def_struct.hpp:2864
V2NIMConversationType type
会话类型
Definition v2_nim_def_struct.hpp:2846
本地会话查询选项
Definition v2_nim_def_struct.hpp:2893
bool onlyUnread
是否仅返回有未读消息的会话,true 表示只返回有未读消息的会话,false 表示返回所有会话
Definition v2_nim_def_struct.hpp:2897
nstd::vector< V2NIMConversationType > conversationTypes
查询指定会话类型,留空表示不限制会话类型
Definition v2_nim_def_struct.hpp:2895
本地会话查询结果
Definition v2_nim_def_struct.hpp:2883
nstd::vector< V2NIMLocalConversation > conversationList
本地会话列表
Definition v2_nim_def_struct.hpp:2889
uint32_t offset
下一次偏移量
Definition v2_nim_def_struct.hpp:2885
bool finished
数据是否拉取完毕,true 表示拉取完毕,false 表示还有数据
Definition v2_nim_def_struct.hpp:2887
Definition v2_nim_def_struct.hpp:2032
nstd::optional< double > y
空间坐标 Y
Definition v2_nim_def_struct.hpp:2036
nstd::optional< double > z
空间坐标 Z
Definition v2_nim_def_struct.hpp:2038
nstd::optional< double > x
空间坐标 X
Definition v2_nim_def_struct.hpp:2034
Definition v2_nim_def_struct.hpp:1329
uint64_t timestamp
登录时间
Definition v2_nim_def_struct.hpp:1335
V2NIMLoginClientType type
客户端类型
Definition v2_nim_def_struct.hpp:1331
nstd::string clientId
客户端 ID
Definition v2_nim_def_struct.hpp:1341
uint32_t customClientType
自定义类型
Definition v2_nim_def_struct.hpp:1339
nstd::string customTag
自定义信息
Definition v2_nim_def_struct.hpp:1337
nstd::string clientIP
客户端外网 IP 地址
Definition v2_nim_def_struct.hpp:1343
nstd::string os
操作系统
Definition v2_nim_def_struct.hpp:1333
Definition v2_nim_def_struct.hpp:1310
uint32_t retryCount
重试次数
Definition v2_nim_def_struct.hpp:1312
V2NIMLoginExtensionProvider loginExtensionProvider
登陆扩展信息获取回调
Definition v2_nim_def_struct.hpp:1322
bool forceMode
强制登录模式
Definition v2_nim_def_struct.hpp:1316
V2NIMDataSyncLevel syncLevel
数据同步等级
Definition v2_nim_def_struct.hpp:1324
V2NIMLoginAuthType authType
认证类型
Definition v2_nim_def_struct.hpp:1318
uint64_t timeout
登录超时, 单位毫秒
Definition v2_nim_def_struct.hpp:1314
V2NIMTokenProvider tokenProvider
动态 token 获取回调
Definition v2_nim_def_struct.hpp:1320
V2NIMRouteConfig routeConfig
路由配置(抄送)配置
Definition v2_nim_def_struct.hpp:1326
消息 AI 相关配置
Definition v2_nim_def_struct.hpp:698
nstd::optional< nstd::vector< V2NIMAIRAGInfo > > aiRAGs
AI RAG(Retrieval-Augmented Generation) 信息
Definition v2_nim_def_struct.hpp:708
V2NIMMessageAIStreamStatus aiStreamStatus
流式消息状态
Definition v2_nim_def_struct.hpp:706
V2NIMMessageAIStatus aiStatus
缺省表示普通消息
Definition v2_nim_def_struct.hpp:702
bool aiStream
是否是流式消息
Definition v2_nim_def_struct.hpp:704
nstd::optional< V2NIMMessageAIStreamChunk > aiStreamLastChunk
流式消息的分片信息
Definition v2_nim_def_struct.hpp:710
nstd::string accountId
数字人账号信息
Definition v2_nim_def_struct.hpp:700
Definition v2_nim_def_struct.hpp:713
nstd::string accountId
数字人账号信息
Definition v2_nim_def_struct.hpp:715
bool aiStream
是否是流式响应,默认 false
Definition v2_nim_def_struct.hpp:717
nstd::optional< V2NIMAIModelCallContent > content
请求大模型的内容
Definition v2_nim_def_struct.hpp:719
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition v2_nim_def_struct.hpp:723
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:721
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空, 则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:725
Definition v2_nim_def_struct.hpp:944
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition v2_nim_def_struct.hpp:952
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:954
V2NIMAIModelCallContent aiModelCallParams
请求大模型的内容
Definition v2_nim_def_struct.hpp:948
nstd::optional< nstd::vector< V2NIMMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:950
nstd::string accountId
AI 代理人的账号
Definition v2_nim_def_struct.hpp:946
重新生成 AI 回复消息参数
Definition v2_nim_def_struct.hpp:2920
V2NIMMessageAIRegenOpType operationType
重新输出数字人消息操作类型
Definition v2_nim_def_struct.hpp:2922
消息 AI 流式消息分片信息
Definition v2_nim_def_struct.hpp:684
nstd::string content
流式消息回复分片文本
Definition v2_nim_def_struct.hpp:686
time_t chunkTime
流式消息当前分片时间,chunkTime >= messageTime
Definition v2_nim_def_struct.hpp:690
time_t messageTime
流式消息时间,即占位消息时间
Definition v2_nim_def_struct.hpp:688
uint32_t index
分片序号,从 0 开始
Definition v2_nim_def_struct.hpp:694
int type
类型,当前仅支持 0 表示文本
Definition v2_nim_def_struct.hpp:692
停止数字人流式输出配置参数
Definition v2_nim_def_struct.hpp:2912
V2NIMMessageAIStreamStopOpType operationType
停止流式消息的操作类型
Definition v2_nim_def_struct.hpp:2914
nstd::optional< nstd::string > updateContent
更新的消息内容,仅当 operationType == V2NIM_MESSAGE_AI_STREAM_STOP_OP_UPDATE 有效
Definition v2_nim_def_struct.hpp:2916
Definition v2_nim_def_struct.hpp:513
nstd::optional< nstd::string > antispamExtension
易盾反垃圾(增强检测数据), json格式, 限制长度 1024 字节
Definition v2_nim_def_struct.hpp:525
bool antispamEnabled
指定是否需要过安全通
Definition v2_nim_def_struct.hpp:515
nstd::optional< nstd::string > antispamCustomMessage
Definition v2_nim_def_struct.hpp:521
nstd::optional< nstd::string > antispamCheating
易盾反作弊(辅助检测数据), json格式, 限制长度 1024 字节
Definition v2_nim_def_struct.hpp:523
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id, 而不使用云信后台配置的
Definition v2_nim_def_struct.hpp:517
Definition v2_nim_def_struct.hpp:310
nstd::string raw
附件内容
Definition v2_nim_def_struct.hpp:312
V2NIMMessageAttachmentType attachmentType
Definition v2_nim_def_struct.hpp:314
virtual ~V2NIMMessageAttachment()=default
Definition v2_nim_def_struct.hpp:349
uint32_t duration
语音文件播放时长
Definition v2_nim_def_struct.hpp:352
V2NIMMessageAudioAttachment()
Definition v2_nim_def_struct.hpp:350
Definition v2_nim_def_struct.hpp:378
int32_t status
通话状态,业务自定义状态
Definition v2_nim_def_struct.hpp:385
nstd::string channelId
话单频道 ID
Definition v2_nim_def_struct.hpp:383
V2NIMMessageCallAttachment()
Definition v2_nim_def_struct.hpp:379
nstd::vector< V2NIMMessageCallDuration > durations
通话成员时长列表
Definition v2_nim_def_struct.hpp:387
int32_t type
话单类型, 业务自定义
Definition v2_nim_def_struct.hpp:381
话单消息通话时长描述信息
Definition v2_nim_def_struct.hpp:288
uint32_t duration
通话时长, 单位秒
Definition v2_nim_def_struct.hpp:292
nstd::string accountId
话单对应成员的账号 ID
Definition v2_nim_def_struct.hpp:290
Definition v2_nim_def_struct.hpp:1110
nstd::string replaceContent
处理后的文本内容
Definition v2_nim_def_struct.hpp:1114
V2NIMMessageClientAntispamOperatorType operateType
客户端反垃圾文本命中后操作类型
Definition v2_nim_def_struct.hpp:1112
Definition v2_nim_def_struct.hpp:562
bool readReceiptEnabled
是否需要消息已读回执信息
Definition v2_nim_def_struct.hpp:564
bool lastMessageUpdateEnabled
是否需要更新消息所属的会话信息
Definition v2_nim_def_struct.hpp:566
bool historyEnabled
是否需要存历史消息
Definition v2_nim_def_struct.hpp:568
bool onlineSyncEnabled
是否需要发送方多端在线同步消息
Definition v2_nim_def_struct.hpp:572
bool unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:576
bool offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:574
bool roamingEnabled
是否需要存漫游消息
Definition v2_nim_def_struct.hpp:570
自定义消息附件
Definition v2_nim_def_struct.hpp:2739
virtual void parse(const nstd::string &attach)=0
V2NIMMessageCustomAttachment()
Definition v2_nim_def_struct.hpp:2740
自定义消息附件解析器
Definition v2_nim_def_struct.hpp:2745
virtual ~V2NIMMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition v2_nim_def_struct.hpp:1212
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition v2_nim_def_struct.hpp:1220
uint64_t deleteTime
被删除的时间
Definition v2_nim_def_struct.hpp:1218
nstd::optional< V2NIMMessage > message
原始消息
Definition v2_nim_def_struct.hpp:1216
V2NIMMessageRefer messageRefer
被删除的消息引用
Definition v2_nim_def_struct.hpp:1214
Definition v2_nim_def_struct.hpp:319
nstd::string path
文件本地路径
Definition v2_nim_def_struct.hpp:330
nstd::string ext
文件扩展名
Definition v2_nim_def_struct.hpp:332
nstd::string name
文件显示名称
Definition v2_nim_def_struct.hpp:328
V2NIMMessageFileAttachment()
Definition v2_nim_def_struct.hpp:320
nstd::string url
文件 url
Definition v2_nim_def_struct.hpp:326
V2NIMMessageAttachmentUploadState uploadState
附件上传状态
Definition v2_nim_def_struct.hpp:336
nstd::string sceneName
文件存储场景
Definition v2_nim_def_struct.hpp:334
nstd::string md5
文件 md5
Definition v2_nim_def_struct.hpp:324
uint64_t size
文件大小
Definition v2_nim_def_struct.hpp:322
消息过滤器对象
Definition v2_nim_def_struct.hpp:2972
nstd::function< bool(const V2NIMMessage &) shouldIgnore)
消息过滤函数实现,返回 true 表示忽略该消息,返回 false 表示不忽略该消息
Definition v2_nim_def_struct.hpp:2974
Definition v2_nim_def_struct.hpp:752
nstd::optional< V2NIMMessageStreamConfig > streamConfig
消息流式相关配置
Definition v2_nim_def_struct.hpp:812
bool isDeleted
消息是否已经被删除
Definition v2_nim_def_struct.hpp:808
bool isSelf
消息发送者是否是自己
Definition v2_nim_def_struct.hpp:806
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:794
nstd::optional< nstd::string > localExtension
本地扩展
Definition v2_nim_def_struct.hpp:782
V2NIMLoginClientType fromClientType
发送此消息的客户端类型
Definition v2_nim_def_struct.hpp:820
uint32_t audioState
音频消息状态
Definition v2_nim_def_struct.hpp:774
uint64_t createTime
消息时间
Definition v2_nim_def_struct.hpp:758
nstd::string conversationId
消息所属会话 ID
Definition v2_nim_def_struct.hpp:768
nstd::optional< uint64_t > modifyTime
消息更新时间
Definition v2_nim_def_struct.hpp:814
nstd::optional< V2NIMMessageRefer > threadReply
回复消息引用
Definition v2_nim_def_struct.hpp:804
V2NIMMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:792
nstd::string receiverId
消息接收者账号
Definition v2_nim_def_struct.hpp:764
V2NIMConversationType conversationType
消息所属会话类型
Definition v2_nim_def_struct.hpp:766
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:798
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition v2_nim_def_struct.hpp:780
nstd::optional< V2NIMMessageAIConfig > aiConfig
AI 数字人相关信息
Definition v2_nim_def_struct.hpp:810
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:796
nstd::string senderId
消息发送者账号
Definition v2_nim_def_struct.hpp:760
nstd::optional< nstd::string > callbackExtension
回调扩展
Definition v2_nim_def_struct.hpp:784
nstd::string senderName
消息发送者发送该消息时那一刻的昵称
Definition v2_nim_def_struct.hpp:762
nstd::optional< V2NIMMessageRefer > threadRoot
Thread 消息引用
Definition v2_nim_def_struct.hpp:802
uint32_t subType
消息子类型
Definition v2_nim_def_struct.hpp:772
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:778
nstd::string messageServerId
服务端消息 ID
Definition v2_nim_def_struct.hpp:756
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition v2_nim_def_struct.hpp:800
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:786
V2NIMMessageStatus messageStatus
消息状态
Definition v2_nim_def_struct.hpp:790
nstd::optional< nstd::string > modifyAccountId
消息更新者账号
Definition v2_nim_def_struct.hpp:816
V2NIMMessageType messageType
消息类型
Definition v2_nim_def_struct.hpp:770
nstd::string messageClientId
客户端消息 ID
Definition v2_nim_def_struct.hpp:754
V2NIMMessageSource messageSource
消息来源
Definition v2_nim_def_struct.hpp:818
nstd::string text
消息文本
Definition v2_nim_def_struct.hpp:776
nstd::optional< V2NIMMessageAttachmentUploadState > attachmentUploadState
附件上传状态
Definition v2_nim_def_struct.hpp:788
Definition v2_nim_def_struct.hpp:340
uint32_t width
图片宽度
Definition v2_nim_def_struct.hpp:343
uint32_t height
图片高度
Definition v2_nim_def_struct.hpp:345
V2NIMMessageImageAttachment()
Definition v2_nim_def_struct.hpp:341
Definition v2_nim_def_struct.hpp:1117
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1133
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:1121
uint64_t endTime
消息查询结束时间, 闭区间
Definition v2_nim_def_struct.hpp:1125
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:1127
bool reverse
是否反向排序
Definition v2_nim_def_struct.hpp:1131
nstd::optional< V2NIMMessage > anchorMessage
锚点消息, 根据锚点消息查询, 不包含该消息
Definition v2_nim_def_struct.hpp:1129
bool onlyQueryLocal
是否只查询本地消息
Definition v2_nim_def_struct.hpp:1137
nstd::vector< V2NIMMessageType > messageTypes
根据消息类型查询会话, 为空表示查询所有消息类型
Definition v2_nim_def_struct.hpp:1119
uint64_t beginTime
消息查询开始时间, 闭区间
Definition v2_nim_def_struct.hpp:1123
bool strictMode
严格模式, 无法确定消息完整性则返回错误
Definition v2_nim_def_struct.hpp:1135
消息列表结果
Definition v2_nim_def_struct.hpp:1159
nstd::vector< V2NIMMessage > messages
消息列表
Definition v2_nim_def_struct.hpp:1161
nstd::optional< V2NIMMessage > anchorMessage
锚点消息, 用于下一次查询
Definition v2_nim_def_struct.hpp:1163
Definition v2_nim_def_struct.hpp:367
nstd::string address
详细位置信息
Definition v2_nim_def_struct.hpp:374
double longitude
经度
Definition v2_nim_def_struct.hpp:372
double latitude
纬度
Definition v2_nim_def_struct.hpp:370
V2NIMMessageLocationAttachment()
Definition v2_nim_def_struct.hpp:368
Definition v2_nim_def_struct.hpp:1019
V2NIMMessageRefer messageRefer
pin 消息引用
Definition v2_nim_def_struct.hpp:1021
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:1029
nstd::string operatorId
操作者 ID
Definition v2_nim_def_struct.hpp:1023
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1025
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:1027
Definition v2_nim_def_struct.hpp:1032
V2NIMMessagePin pin
消息相关的PIN信息
Definition v2_nim_def_struct.hpp:1036
V2NIMMessagePinState pinState
消息 PIN 状态
Definition v2_nim_def_struct.hpp:1034
Definition v2_nim_def_struct.hpp:479
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition v2_nim_def_struct.hpp:483
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition v2_nim_def_struct.hpp:493
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition v2_nim_def_struct.hpp:489
nstd::string pushPayload
推送数据
Definition v2_nim_def_struct.hpp:487
nstd::string pushContent
推送文本
Definition v2_nim_def_struct.hpp:485
bool pushEnabled
是否需要推送消息
Definition v2_nim_def_struct.hpp:481
nstd::string forcePushContent
强制推送文案
Definition v2_nim_def_struct.hpp:491
Definition v2_nim_def_struct.hpp:620
uint64_t begin
起始时间
Definition v2_nim_def_struct.hpp:622
bool includeEnd
包含结束时间
Definition v2_nim_def_struct.hpp:628
uint64_t end
结束时间
Definition v2_nim_def_struct.hpp:624
bool includeBegin
包含起始时间
Definition v2_nim_def_struct.hpp:626
Definition v2_nim_def_struct.hpp:588
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:600
nstd::string receiverId
接收方账号
Definition v2_nim_def_struct.hpp:592
nstd::string senderId
发送方账号
Definition v2_nim_def_struct.hpp:590
nstd::string messageServerId
服务端消息 id
Definition v2_nim_def_struct.hpp:596
uint64_t createTime
消息时间
Definition v2_nim_def_struct.hpp:602
V2NIMConversationType conversationType
会话类型
Definition v2_nim_def_struct.hpp:598
nstd::string messageClientId
客户端消息 id
Definition v2_nim_def_struct.hpp:594
Definition v2_nim_def_struct.hpp:1002
V2NIMMessageRefer messageRefer
被撤回的消息引用
Definition v2_nim_def_struct.hpp:1004
nstd::string revokeAccountId
消息撤回者账号
Definition v2_nim_def_struct.hpp:1012
nstd::optional< nstd::string > postscript
附言
Definition v2_nim_def_struct.hpp:1010
nstd::optional< nstd::string > callbackExtension
第三方回调传入的自定义扩展字段
Definition v2_nim_def_struct.hpp:1016
V2NIMMessageRevokeType revokeType
消息撤回类型
Definition v2_nim_def_struct.hpp:1014
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:1008
nstd::optional< V2NIMMessage > message
原始消息
Definition v2_nim_def_struct.hpp:1006
Definition v2_nim_def_struct.hpp:989
nstd::optional< nstd::string > env
路由抄送地址
Definition v2_nim_def_struct.hpp:999
nstd::optional< nstd::string > pushPayload
推送数据
Definition v2_nim_def_struct.hpp:997
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:993
nstd::optional< nstd::string > pushContent
推送文案
Definition v2_nim_def_struct.hpp:995
nstd::optional< nstd::string > postscript
附言
Definition v2_nim_def_struct.hpp:991
Definition v2_nim_def_struct.hpp:537
nstd::optional< nstd::string > function
机器人具体功能, 用户可以自定义输入
Definition v2_nim_def_struct.hpp:543
nstd::optional< nstd::string > customContent
机器人自定义内容
Definition v2_nim_def_struct.hpp:545
nstd::optional< nstd::string > accountId
机器人账号, 仅群聊有效
Definition v2_nim_def_struct.hpp:539
nstd::optional< nstd::string > topic
机器人消息话题
Definition v2_nim_def_struct.hpp:541
Definition v2_nim_def_struct.hpp:548
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition v2_nim_def_struct.hpp:552
bool routeEnabled
是否需要路由消息
Definition v2_nim_def_struct.hpp:550
消息检索参数
Definition v2_nim_def_struct.hpp:2783
V2NIMSearchDirection direction
检索方向 V2NIMSearchDirection,默认为 V2NIM_SEARCH_DIRECTION_BACKWARD
Definition v2_nim_def_struct.hpp:2801
bool totalCount
所有返回关联内容总数,为 true 时将计算搜索条件命中的所有数据总数,有性能损耗
Definition v2_nim_def_struct.hpp:2809
bool tokenizer
Definition v2_nim_def_struct.hpp:2813
nstd::optional< nstd::string > conversationId
要查询的会话 ID,不指定则查询所有会话
Definition v2_nim_def_struct.hpp:2785
int64_t searchTimePeriod
从起始时间点开始的过去时间范围,默认为 0(不限制时间范围)。24 x 60 x 60 x 1000 代表过去一天,单位:毫秒
Definition v2_nim_def_struct.hpp:2799
nstd::optional< nstd::vector< nstd::string > > senderAccountIds
匹配消息发送者,最多支持 5 个,为空则匹配所有发送者
Definition v2_nim_def_struct.hpp:2791
V2NIMSearchKeywordMathType keywordMatchType
指定关键字列表匹配类型,见 V2NIMSearchKeywordMathType,默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition v2_nim_def_struct.hpp:2789
uint32_t limit
搜索的数量限制,默认为 20,最大为 100
Definition v2_nim_def_struct.hpp:2805
nstd::optional< nstd::string > pageToken
下一页的 token,用于分页查询
Definition v2_nim_def_struct.hpp:2807
nstd::optional< nstd::vector< nstd::string > > keywordList
要查询的关键字列表,为空则按发送者或消息类型查询,最多支持 5 个。当消息发送者以及消息类型均未指定时,必须设置关键字列表
Definition v2_nim_def_struct.hpp:2787
V2NIMSearchStrategy strategy
检索策略 V2NIMSearchStrategy,默认为 V2NIM_SEARCH_STRATEGY_FTS
Definition v2_nim_def_struct.hpp:2803
time_t searchStartTime
搜索的起始时间点,默认为 0(从现在开始搜索)。UTC 时间戳,单位:毫秒
Definition v2_nim_def_struct.hpp:2797
nstd::optional< nstd::vector< V2NIMMessageType > > messageTypes
匹配消息类型,为空则匹配所有类型
Definition v2_nim_def_struct.hpp:2793
nstd::optional< nstd::vector< int32_t > > messageSubtypes
匹配消息子类型,为空则匹配所有子类型
Definition v2_nim_def_struct.hpp:2795
查询消息返回的结果项
Definition v2_nim_def_struct.hpp:2817
uint32_t count
单个会话命中的数量
Definition v2_nim_def_struct.hpp:2823
nstd::vector< V2NIMMessage > messages
返回的消息列表
Definition v2_nim_def_struct.hpp:2821
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:2819
Definition v2_nim_def_struct.hpp:1485
nstd::vector< V2NIMMessageType > messageTypes
要检索的消息类型, 为空表示查询所有消息类型
Definition v2_nim_def_struct.hpp:1505
nstd::vector< nstd::string > teamIds
高级群账号列表
Definition v2_nim_def_struct.hpp:1501
nstd::vector< nstd::string > p2pAccountIds
P2P 账号列表
Definition v2_nim_def_struct.hpp:1499
nstd::vector< nstd::string > senderAccountIds
发送账号列表
Definition v2_nim_def_struct.hpp:1503
uint64_t beginTime
查询起始时间
Definition v2_nim_def_struct.hpp:1489
uint32_t messageLimit
返回消息数量
Definition v2_nim_def_struct.hpp:1495
nstd::vector< uint32_t > messageSubTypes
要检索的消息子类型, 为空表示查询所有消息子类型
Definition v2_nim_def_struct.hpp:1507
V2NIMSortOrder sortOrder
消息排序规则
Definition v2_nim_def_struct.hpp:1497
nstd::string keyword
关键字
Definition v2_nim_def_struct.hpp:1487
uint32_t conversationLimit
检索会话数量
Definition v2_nim_def_struct.hpp:1493
uint64_t endTime
查询结束时间, 0 表示当前时间
Definition v2_nim_def_struct.hpp:1491
查询消息返回的结果
Definition v2_nim_def_struct.hpp:2827
nstd::vector< V2NIMMessageSearchItem > items
Definition v2_nim_def_struct.hpp:2836
nstd::string nextPageToken
下次请求的 token,两次查询参数必须一致
Definition v2_nim_def_struct.hpp:2838
uint32_t count
满足检索条件的所有消息数量
Definition v2_nim_def_struct.hpp:2829
Definition v2_nim_def_struct.hpp:631
V2NIMErrorCode errorCode
消息发送失败后的错误码信息
Definition v2_nim_def_struct.hpp:633
bool readReceiptSent
Definition v2_nim_def_struct.hpp:636
消息流式消息分片信息
Definition v2_nim_def_struct.hpp:729
time_t messageTime
流式消息时间,即占位消息时间
Definition v2_nim_def_struct.hpp:733
time_t chunkTime
流式消息当前分片时间,chunkTime >= messageTime
Definition v2_nim_def_struct.hpp:735
int type
类型,当前仅支持 0 表示文本
Definition v2_nim_def_struct.hpp:737
nstd::string content
流式消息回复分片文本
Definition v2_nim_def_struct.hpp:731
uint32_t index
分片序号,从 0 开始
Definition v2_nim_def_struct.hpp:739
消息体当中的流式相关配置字段
Definition v2_nim_def_struct.hpp:743
nstd::optional< nstd::vector< V2NIMAIRAGInfo > > rags
AI RAG(Retrieval-Augmented Generation) 信息
Definition v2_nim_def_struct.hpp:747
nstd::optional< V2NIMMessageStreamChunk > lastChunk
流式消息最近一个分片,流式过程中才有该字段,最终完整消息无此字段
Definition v2_nim_def_struct.hpp:749
V2NIMMessageStreamStatus status
流式消息状态
Definition v2_nim_def_struct.hpp:745
群组定向消息数据结构
Definition v2_nim_def_struct.hpp:959
nstd::vector< nstd::string > receiverIds
接收者 ID 列表
Definition v2_nim_def_struct.hpp:963
bool inclusive
为 true 时表示消息发送到群组中 receiverIds 对应的成员,为 false 时表示消息发送到群组中排除 receiverIds 以外的所有成员
Definition v2_nim_def_struct.hpp:961
bool newMemberVisible
新成员是否可以查看该定向消息
Definition v2_nim_def_struct.hpp:965
Definition v2_nim_def_struct.hpp:391
V2NIMMessageNotificationType type
通知类型
Definition v2_nim_def_struct.hpp:394
nstd::vector< nstd::string > targetIds
被操作者 ID 列表
Definition v2_nim_def_struct.hpp:398
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:396
bool chatBanned
群成员是否被禁言
Definition v2_nim_def_struct.hpp:400
V2NIMMessageTeamNotificationAttachment()
Definition v2_nim_def_struct.hpp:392
nstd::optional< V2NIMUpdatedTeamInfo > updatedTeamInfo
群信息更新字段,有相应字段信息,则表示对应字段被修改
Definition v2_nim_def_struct.hpp:402
Definition v2_nim_def_struct.hpp:356
uint32_t height
图片高度
Definition v2_nim_def_struct.hpp:363
V2NIMMessageVideoAttachment()
Definition v2_nim_def_struct.hpp:357
uint32_t width
图片宽度
Definition v2_nim_def_struct.hpp:361
uint32_t duration
视频文件播放时长
Definition v2_nim_def_struct.hpp:359
Definition v2_nim_def_struct.hpp:834
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:840
nstd::optional< V2NIMMessageRouteConfig > routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:846
nstd::optional< uint32_t > subType
消息子类型
Definition v2_nim_def_struct.hpp:836
nstd::optional< V2NIMMessageAntispamConfig > antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:844
nstd::optional< nstd::string > text
消息内容
Definition v2_nim_def_struct.hpp:838
nstd::optional< nstd::string > serverExtension
消息服务端扩展
Definition v2_nim_def_struct.hpp:842
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:850
nstd::optional< V2NIMMessagePushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:848
nstd::optional< nstd::string > clientAntispamReplace
反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:852
Definition v2_nim_def_struct.hpp:1066
nstd::string antispamResult
云端反垃圾返回的结果
Definition v2_nim_def_struct.hpp:1072
V2NIMMessage message
修改成功后的消息体
Definition v2_nim_def_struct.hpp:1068
V2NIMClientAntispamResult clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:1074
int32_t errorCode
返回错误码
Definition v2_nim_def_struct.hpp:1070
Definition v2_nim_def_struct.hpp:528
nstd::optional< nstd::string > antispamCustomMessage
Definition v2_nim_def_struct.hpp:534
bool antispamEnabled
指定是否需要过安全通
Definition v2_nim_def_struct.hpp:530
Definition v2_nim_def_struct.hpp:579
nstd::optional< nstd::string > clientNotificationId
外部输入标识字段,建议输入时每次串唯一,长度不超过 32 个字符
Definition v2_nim_def_struct.hpp:585
bool offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:581
bool unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:583
Definition v2_nim_def_struct.hpp:496
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition v2_nim_def_struct.hpp:500
nstd::string forcePushContent
强制推送文案
Definition v2_nim_def_struct.hpp:508
bool pushEnabled
是否需要推送通知
Definition v2_nim_def_struct.hpp:498
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition v2_nim_def_struct.hpp:506
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition v2_nim_def_struct.hpp:510
nstd::string pushPayload
推送数据
Definition v2_nim_def_struct.hpp:504
nstd::string pushContent
推送文本
Definition v2_nim_def_struct.hpp:502
Definition v2_nim_def_struct.hpp:555
bool routeEnabled
是否需要路由通知
Definition v2_nim_def_struct.hpp:557
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition v2_nim_def_struct.hpp:559
Definition v2_nim_def_struct.hpp:1101
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:1103
uint64_t timestamp
最后一条已读消息时间, 比该时间早的消息都可以认为已读
Definition v2_nim_def_struct.hpp:1105
uint64_t actionTime
最后操作时间
Definition v2_nim_def_struct.hpp:1107
好友申请附言历史
Definition v2_nim_def_struct.hpp:1883
nstd::string content
附言内容
Definition v2_nim_def_struct.hpp:1889
nstd::string fromAccount
产生附言的账号
Definition v2_nim_def_struct.hpp:1885
uint64_t time
附言产生的时间
Definition v2_nim_def_struct.hpp:1887
Definition v2_nim_def_struct.hpp:62
nstd::string defaultNosUploadAddress
默认 nos 上传地址
Definition v2_nim_def_struct.hpp:74
nstd::string defaultNosUploadHost
默认 nos 上传主机地址
Definition v2_nim_def_struct.hpp:76
nstd::string probeIpv4Url
探测 ipv4 地址类型使用的 url
Definition v2_nim_def_struct.hpp:86
nstd::string nosDownloadAddress
nos 下载地址拼接模板, 用于拼接最终得到的下载地址
Definition v2_nim_def_struct.hpp:78
nstd::string asymmetricEncryptionKeyA
非对称加密密钥 A, RSA: module, SM2: X
Definition v2_nim_def_struct.hpp:90
uint32_t asymmetricEncryptionKeyVersion
非对称加密算法 key 版本号
Definition v2_nim_def_struct.hpp:94
V2NIMIPProtocolVersion ipProtocolVersion
IP 协议版本
Definition v2_nim_def_struct.hpp:64
nstd::vector< nstd::string > lbsAddresses
lbs 地址
Definition v2_nim_def_struct.hpp:66
nstd::string defaultLinkAddress
默认 link 地址
Definition v2_nim_def_struct.hpp:70
nstd::vector< nstd::string > nosAccelerateHosts
nos 加速域名列表
Definition v2_nim_def_struct.hpp:80
nstd::string nosLbsAddress
nos lbs 地址
Definition v2_nim_def_struct.hpp:68
nstd::string asymmetricEncryptionKeyB
非对称加密密钥 B, RSA: EXP, SM2: SM2Y
Definition v2_nim_def_struct.hpp:92
nstd::string probeIpv6Url
探测 ipv6 地址类型使用的 url
Definition v2_nim_def_struct.hpp:88
nstd::string nosAccelerateAddress
nos 加速地址拼接模板, 用于获得加速后的下载地址
Definition v2_nim_def_struct.hpp:82
uint64_t nosMaxUploadPartSize
默认上传分片大小,单位字节。如您想设置分片大小为 5MB,则应设置为 5 * 1024 * 1024
Definition v2_nim_def_struct.hpp:84
nstd::string defaultLinkAddressIpv6
默认 ipv6 link 地址
Definition v2_nim_def_struct.hpp:72
Definition v2_nim_def_struct.hpp:917
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id
Definition v2_nim_def_struct.hpp:921
nstd::optional< bool > antispamEnabled
指定消息是否需要经过安全通。默认为 true
Definition v2_nim_def_struct.hpp:919
AI 数字人代理请求参数
Definition v2_nim_def_struct.hpp:925
nstd::string requestId
请求 ID
Definition v2_nim_def_struct.hpp:929
bool aiStream
是否是流式响应,默认 false
Definition v2_nim_def_struct.hpp:941
nstd::string accountId
机器人账号 ID
Definition v2_nim_def_struct.hpp:927
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换, 如果 V2NIMAIUser 中的 modelConfig.prompt 定义了变量,则必填. 端测不校验
Definition v2_nim_def_struct.hpp:935
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:933
V2NIMAIModelCallContent content
请求大模型的内容
Definition v2_nim_def_struct.hpp:931
nstd::optional< V2NIMProxyAICallAntispamConfig > antispamConfig
反垃圾配置, 复用消息体里的部分反垃圾字段
Definition v2_nim_def_struct.hpp:939
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:937
代理请求回调
Definition v2_nim_def_struct.hpp:2773
time_t time
发送时间,毫秒
Definition v2_nim_def_struct.hpp:2779
nstd::string fromAccountId
发送方账号
Definition v2_nim_def_struct.hpp:2775
nstd::string body
通知体
Definition v2_nim_def_struct.hpp:2777
HTTP 代理请求参数
Definition v2_nim_def_struct.hpp:2751
nstd::optional< nstd::string > body
请求体
Definition v2_nim_def_struct.hpp:2761
nstd::optional< nstd::string > header
请求头
Definition v2_nim_def_struct.hpp:2759
nstd::optional< nstd::string > zone
映射一个请求地址,不传使用服务器默认的配置
Definition v2_nim_def_struct.hpp:2757
V2NIMProxyRequestMethod method
请求方法
Definition v2_nim_def_struct.hpp:2755
nstd::string path
请求路径
Definition v2_nim_def_struct.hpp:2753
HTTP 代理响应
Definition v2_nim_def_struct.hpp:2765
nstd::string header
响应头
Definition v2_nim_def_struct.hpp:2767
nstd::string body
响应体
Definition v2_nim_def_struct.hpp:2769
登陆路由(抄送)配置
Definition v2_nim_def_struct.hpp:154
bool routeEnabled
是否需要路由(抄送)本次登录事件,抄送需要打开控制台抄送配置
Definition v2_nim_def_struct.hpp:156
nstd::optional< nstd::string > routeEnvironment
路由地址
Definition v2_nim_def_struct.hpp:158
群成员检索参数
Definition v2_nim_def_struct.hpp:1718
nstd::optional< nstd::string > nextToken
起始位置,首次传“”, 后续传上次返回的nextToken,该参数仅云端检索有效
Definition v2_nim_def_struct.hpp:1732
nstd::optional< V2NIMSearchKeywordMathType > keywordMatchType
指定关键字列表匹配类型,见 V2NIMSearchKeywordMathType,默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition v2_nim_def_struct.hpp:1722
bool searchAccountId
是否搜索用户账号,默认 false
Definition v2_nim_def_struct.hpp:1726
nstd::optional< nstd::vector< V2NIMTeamRefer > > teamRefers
需要检索的群ID列表,为空则匹配全部群成员,最大为 50
Definition v2_nim_def_struct.hpp:1724
nstd::vector< nstd::string > keywordList
要查询的关键字列表,最多支持 5 个
Definition v2_nim_def_struct.hpp:1720
nstd::optional< uint32_t > limit
搜索的数量限制,默认为 20,不建议超过 100,该参数仅云端检索有效
Definition v2_nim_def_struct.hpp:1730
bool searchTeamNick
是否同时搜索群昵称, 默认 true,searchAccountId 和 searchTeamNick 不能同时为 false, 否返回参数错误
Definition v2_nim_def_struct.hpp:1728
Definition v2_nim_def_struct.hpp:2185
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:2191
nstd::string clientAntispamReplace
反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:2195
nstd::vector< nstd::string > receiverIds
定向消息接收者账号列表, 为空表示不定向, 定向消息不存历史
Definition v2_nim_def_struct.hpp:2197
V2NIMChatroomMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:2187
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:2199
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition v2_nim_def_struct.hpp:2201
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:2189
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:2193
Definition v2_nim_def_struct.hpp:2204
V2NIMChatroomMessage message
发送成功后的消息体
Definition v2_nim_def_struct.hpp:2206
nstd::string antispamResult
云端反垃圾返回的结果
Definition v2_nim_def_struct.hpp:2208
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:2210
Definition v2_nim_def_struct.hpp:1039
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:1047
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:1045
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition v2_nim_def_struct.hpp:1041
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition v2_nim_def_struct.hpp:1043
Definition v2_nim_def_struct.hpp:968
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:976
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition v2_nim_def_struct.hpp:978
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:972
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:974
nstd::string clientAntispamReplace
本地反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:982
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:980
nstd::optional< V2NIMMessageAIConfigParams > aiConfig
请求大模型的相关参数
Definition v2_nim_def_struct.hpp:984
nstd::optional< V2NIMMessageTargetConfig > targetConfig
用以控制在发送群组消息时,消息是否发送给指定的群组成员
Definition v2_nim_def_struct.hpp:986
V2NIMMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:970
Definition v2_nim_def_struct.hpp:1057
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:1063
V2NIMMessage message
发送成功后的消息体
Definition v2_nim_def_struct.hpp:1059
nstd::optional< nstd::string > antispamResult
反垃圾返回的结果
Definition v2_nim_def_struct.hpp:1061
拒绝别人邀请加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2617
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2619
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2623
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2625
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2627
nstd::string inviterAccountId
邀请者账号 ID
Definition v2_nim_def_struct.hpp:2621
信令呼叫参数
Definition v2_nim_def_struct.hpp:2441
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2455
nstd::optional< nstd::string > channelName
频道名称,建议使用与业务有相关场景的名称,便于页面显示
Definition v2_nim_def_struct.hpp:2449
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,跟频道绑定,JSON 格式
Definition v2_nim_def_struct.hpp:2451
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:2457
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2459
nstd::string calleeAccountId
被呼叫者账号 ID
Definition v2_nim_def_struct.hpp:2443
V2NIMSignallingChannelType channelType
频道类型
Definition v2_nim_def_struct.hpp:2447
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2453
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2445
呼叫回包
Definition v2_nim_def_struct.hpp:2523
int32_t callStatus
呼叫状态
Definition v2_nim_def_struct.hpp:2529
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2525
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2527
呼叫建立请求参数,包括接收方进入频道房间相关信息,以及接受方需要的相关音视频房间信息
Definition v2_nim_def_struct.hpp:2533
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2539
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2543
nstd::string callerAccountId
接受的呼叫者账号 ID
Definition v2_nim_def_struct.hpp:2537
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2541
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2535
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2545
接受呼叫请求回包
Definition v2_nim_def_struct.hpp:2549
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2553
nstd::optional< uint32_t > callStatus
呼叫状态
Definition v2_nim_def_struct.hpp:2555
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2551
取消之前的邀请成员加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2587
nstd::string inviteeAccountId
被邀请者账号 ID
Definition v2_nim_def_struct.hpp:2591
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:2599
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2597
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2595
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2589
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2593
信令频道信息
Definition v2_nim_def_struct.hpp:2463
bool channelValid
频道是否有效
Definition v2_nim_def_struct.hpp:2479
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2471
time_t createTime
频道房间创建时间
Definition v2_nim_def_struct.hpp:2473
nstd::optional< nstd::string > channelName
信令频道名称,如果请求时不传,则该字段为空
Definition v2_nim_def_struct.hpp:2469
nstd::string creatorAccountId
创建者账号 ID
Definition v2_nim_def_struct.hpp:2477
nstd::string channelId
信令频道 ID,唯一标识了该频道房间,后续主要以该字段作为请求标识
Definition v2_nim_def_struct.hpp:2465
V2NIMSignallingChannelType channelType
频道类型
Definition v2_nim_def_struct.hpp:2467
time_t expireTime
频道房间过期时间
Definition v2_nim_def_struct.hpp:2475
Definition v2_nim_def_struct.hpp:2409
nstd::optional< bool > unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:2413
nstd::optional< bool > offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:2411
nstd::optional< int64_t > selfUid
用户 UID
Definition v2_nim_def_struct.hpp:2415
信令事件
Definition v2_nim_def_struct.hpp:2631
nstd::string operatorAccountId
操作者 ID
Definition v2_nim_def_struct.hpp:2637
nstd::optional< nstd::string > inviteeAccountId
Definition v2_nim_def_struct.hpp:2645
nstd::string requestId
Definition v2_nim_def_struct.hpp:2655
nstd::optional< V2NIMSignallingMember > member
Definition v2_nim_def_struct.hpp:2665
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2639
nstd::optional< V2NIMSignallingPushConfig > pushConfig
Definition v2_nim_def_struct.hpp:2658
nstd::optional< bool > unreadEnabled
Definition v2_nim_def_struct.hpp:2662
nstd::optional< nstd::string > inviterAccountId
Definition v2_nim_def_struct.hpp:2649
V2NIMSignallingChannelInfo channelInfo
信令频道房间相关信息
Definition v2_nim_def_struct.hpp:2635
uint64_t time
操作的时间点
Definition v2_nim_def_struct.hpp:2641
V2NIMSignallingEventType eventType
信令频道事件类型
Definition v2_nim_def_struct.hpp:2633
邀请成员加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2571
nstd::string inviteeAccountId
被邀请者账号 ID
Definition v2_nim_def_struct.hpp:2575
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:2583
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2581
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2579
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2577
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2573
加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2559
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2561
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2565
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2567
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2563
加入信令房间结果
Definition v2_nim_def_struct.hpp:2515
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2519
V2NIMSignallingRoomInfo roomInfo
信令房间相关信息
Definition v2_nim_def_struct.hpp:2517
信令房间用户信息
Definition v2_nim_def_struct.hpp:2483
time_t joinTime
用户加入信令频道房间时间
Definition v2_nim_def_struct.hpp:2489
int64_t uid
成员 UID
Definition v2_nim_def_struct.hpp:2487
time_t expireTime
用户信令频道房间过期时间
Definition v2_nim_def_struct.hpp:2491
nstd::string deviceId
成员操作的设备 ID
Definition v2_nim_def_struct.hpp:2493
nstd::string accountId
成员账号 ID
Definition v2_nim_def_struct.hpp:2485
消息推送相关配置
Definition v2_nim_def_struct.hpp:2419
nstd::optional< nstd::string > pushTitle
推送标题
Definition v2_nim_def_struct.hpp:2423
nstd::optional< nstd::string > pushContent
推送文案
Definition v2_nim_def_struct.hpp:2425
nstd::optional< nstd::string > pushPayload
推送数据
Definition v2_nim_def_struct.hpp:2427
bool pushEnabled
是否需要推送
Definition v2_nim_def_struct.hpp:2421
拒绝别人邀请加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2603
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2605
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2611
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2613
nstd::string inviterAccountId
邀请者账号 ID
Definition v2_nim_def_struct.hpp:2607
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2609
信令房间相关信息
Definition v2_nim_def_struct.hpp:2497
V2NIMSignallingChannelInfo channelInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2499
nstd::vector< V2NIMSignallingMember > members
成员列表信息
Definition v2_nim_def_struct.hpp:2501
音视频相关配置
Definition v2_nim_def_struct.hpp:2431
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频 SDK 相关参数,IM 信令仅透传相关参数
Definition v2_nim_def_struct.hpp:2437
nstd::optional< nstd::string > rtcChannelName
云信音视频房间频道名称
Definition v2_nim_def_struct.hpp:2433
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition v2_nim_def_struct.hpp:2435
音视频房间信息
Definition v2_nim_def_struct.hpp:2505
nstd::optional< nstd::string > rtcToken
进入音视频对应的 token
Definition v2_nim_def_struct.hpp:2507
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频SDK相关参数,IM 信令仅透传相关参数
Definition v2_nim_def_struct.hpp:2511
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition v2_nim_def_struct.hpp:2509
Definition v2_nim_def_struct.hpp:19
int32_t height
高
Definition v2_nim_def_struct.hpp:23
int32_t width
宽
Definition v2_nim_def_struct.hpp:21
Definition v2_nim_def_struct.hpp:180
uint64_t expireTime
过期时间, 单位秒, 0 表示不过期
Definition v2_nim_def_struct.hpp:184
nstd::string sceneName
场景名
Definition v2_nim_def_struct.hpp:182
事件订阅选项
Definition v2_nim_def_struct.hpp:2669
nstd::vector< nstd::string > accountIds
订阅的成员列表,为空返回参数错误,单次数量不超过 100,列表数量如果超限,默认截取前 100 个账号
Definition v2_nim_def_struct.hpp:2671
uint32_t duration
订阅的有效期,时间范围为 60~2592000,单位:秒,过期后需要重新订阅。如果未过期的情况下重复订阅,新设置的有效期会覆盖之前的有效期
Definition v2_nim_def_struct.hpp:2673
bool immediateSync
订阅后是否立即同步事件状态值,默认为 false,为 true 表示立即同步当前状态值。但为了性能考虑,30s 内重复订阅会忽略该参数
Definition v2_nim_def_struct.hpp:2675
Definition v2_nim_def_struct.hpp:1540
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition v2_nim_def_struct.hpp:1570
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:1578
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:1558
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition v2_nim_def_struct.hpp:1572
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition v2_nim_def_struct.hpp:1568
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition v2_nim_def_struct.hpp:1576
nstd::string ownerAccountId
群组创建者/拥有者 ID
Definition v2_nim_def_struct.hpp:1548
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:1560
bool isValidTeam
是否为自己所在且有效的群, 群存在且我在群组中
Definition v2_nim_def_struct.hpp:1580
nstd::optional< uint64_t > teamMemberTime
Definition v2_nim_def_struct.hpp:1588
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1544
bool isTeamEffective
单纯表示群组是否有效
Definition v2_nim_def_struct.hpp:1582
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1564
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:1562
uint64_t createTime
群组创建时间
Definition v2_nim_def_struct.hpp:1554
bool isDiscussion
是否为讨论组
Definition v2_nim_def_struct.hpp:1584
nstd::string name
群组名称
Definition v2_nim_def_struct.hpp:1546
uint32_t memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:1550
uint32_t bits
Definition v2_nim_def_struct.hpp:1586
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition v2_nim_def_struct.hpp:1574
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由openApi设置
Definition v2_nim_def_struct.hpp:1566
uint64_t updateTime
群组更新时间
Definition v2_nim_def_struct.hpp:1556
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1542
uint32_t memberCount
群组当前人数
Definition v2_nim_def_struct.hpp:1552
Definition v2_nim_def_struct.hpp:1768
nstd::optional< nstd::string > serverExtension
邀请入群的扩展字段, 512 个字符, 目前仅支持高级群, 超大群暂不支持
Definition v2_nim_def_struct.hpp:1774
nstd::vector< nstd::string > inviteeAccountIds
被邀请加入群的成员账号列表, 为 Null || size 为 0, 返回参数错误
Definition v2_nim_def_struct.hpp:1770
nstd::optional< nstd::string > postscript
邀请入群的附言
Definition v2_nim_def_struct.hpp:1772
Definition v2_nim_def_struct.hpp:1777
V2NIMTeamJoinActionStatus actionStatus
操作状态
Definition v2_nim_def_struct.hpp:1791
bool read
是否已读
Definition v2_nim_def_struct.hpp:1795
uint64_t timestamp
申请时间
Definition v2_nim_def_struct.hpp:1789
V2NIMTeamJoinActionType actionType
入群操作类型
Definition v2_nim_def_struct.hpp:1779
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1781
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1783
nstd::string operatorAccountId
申请者账号
Definition v2_nim_def_struct.hpp:1785
nstd::optional< nstd::string > postscript
申请入群的附言
Definition v2_nim_def_struct.hpp:1787
nstd::optional< nstd::string > serverExtension
邀请入群的扩展字段
Definition v2_nim_def_struct.hpp:1793
Definition v2_nim_def_struct.hpp:1944
uint64_t offset
分页偏移
Definition v2_nim_def_struct.hpp:1948
nstd::vector< V2NIMTeamJoinActionStatus > status
查询状态
Definition v2_nim_def_struct.hpp:1952
nstd::vector< V2NIMTeamJoinActionType > types
查询类型
Definition v2_nim_def_struct.hpp:1946
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1950
Definition v2_nim_def_struct.hpp:1972
uint64_t offset
下一次的偏移量
Definition v2_nim_def_struct.hpp:1976
bool finished
分页结束
Definition v2_nim_def_struct.hpp:1978
nstd::vector< V2NIMTeamJoinActionInfo > infos
查询返回的列表
Definition v2_nim_def_struct.hpp:1974
Definition v2_nim_def_struct.hpp:1597
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition v2_nim_def_struct.hpp:1619
nstd::vector< nstd::string > followAccountIds
特别关注群成员 account ID 列表
Definition v2_nim_def_struct.hpp:1621
nstd::optional< bool > inTeam
是否在群中
Definition v2_nim_def_struct.hpp:1617
nstd::string accountId
群组成员账号
Definition v2_nim_def_struct.hpp:1603
nstd::optional< uint64_t > joinTime
入群时间
Definition v2_nim_def_struct.hpp:1611
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1613
nstd::optional< uint64_t > bits
Definition v2_nim_def_struct.hpp:1623
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1601
nstd::optional< nstd::string > teamNick
群组昵称
Definition v2_nim_def_struct.hpp:1607
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition v2_nim_def_struct.hpp:1615
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition v2_nim_def_struct.hpp:1605
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1609
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1599
Definition v2_nim_def_struct.hpp:1759
nstd::vector< V2NIMTeamMember > memberList
拉取的成员列表
Definition v2_nim_def_struct.hpp:1765
nstd::string nextToken
下一次查询的偏移量
Definition v2_nim_def_struct.hpp:1763
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:1761
Definition v2_nim_def_struct.hpp:1683
V2NIMTeamMemberRoleQueryType roleQueryType
群成员类型
Definition v2_nim_def_struct.hpp:1685
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1689
uint32_t limit
分页拉取数量
Definition v2_nim_def_struct.hpp:1693
bool onlyChatBanned
是否只返回聊天禁言成员列表
Definition v2_nim_def_struct.hpp:1687
nstd::string nextToken
分页偏移, 首次传空, 后续拉取采用上一次返回的 nextToken
Definition v2_nim_def_struct.hpp:1691
Definition v2_nim_def_struct.hpp:1955
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1959
nstd::string nextToken
Definition v2_nim_def_struct.hpp:1965
bool searchAccountId
是否按账号 ID 查询
Definition v2_nim_def_struct.hpp:1963
V2NIMSortOrder order
按照 joinTime 排序,默认时间降序排列
Definition v2_nim_def_struct.hpp:1967
nstd::optional< nstd::string > teamId
群组ID,如果不传则检索所有群,如果需要检索特定的群,则需要同时传入 teamId + teamType
Definition v2_nim_def_struct.hpp:1961
uint32_t limit
查询成员的个数,默认 10
Definition v2_nim_def_struct.hpp:1969
nstd::string keyword
搜索关键词,不为空
Definition v2_nim_def_struct.hpp:1957
Definition v2_nim_def_struct.hpp:1627
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1645
nstd::optional< bool > inTeam
是否在群中
Definition v2_nim_def_struct.hpp:1649
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition v2_nim_def_struct.hpp:1647
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1641
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition v2_nim_def_struct.hpp:1651
nstd::optional< nstd::string > teamNick
群组昵称
Definition v2_nim_def_struct.hpp:1637
nstd::optional< uint64_t > joinTime
入群时间
Definition v2_nim_def_struct.hpp:1643
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition v2_nim_def_struct.hpp:1635
nstd::string accountId
群组成员账号
Definition v2_nim_def_struct.hpp:1633
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1629
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1631
nstd::optional< uint64_t > bits
内部使用字段
Definition v2_nim_def_struct.hpp:1639
Definition v2_nim_def_struct.hpp:1092
nstd::vector< nstd::string > readAccountList
已读账号列表
Definition v2_nim_def_struct.hpp:1096
V2NIMTeamMessageReadReceipt readReceipt
群消息已读回执
Definition v2_nim_def_struct.hpp:1094
nstd::vector< nstd::string > unreadAccountList
未读账号列表
Definition v2_nim_def_struct.hpp:1098
Definition v2_nim_def_struct.hpp:1077
nstd::optional< nstd::string > latestReadAccount
群消息最新已读账号
Definition v2_nim_def_struct.hpp:1089
uint32_t readCount
群消息已读人数
Definition v2_nim_def_struct.hpp:1085
nstd::string messageClientId
消息客户端 ID
Definition v2_nim_def_struct.hpp:1083
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:1079
uint32_t unreadCount
群消息未读人数
Definition v2_nim_def_struct.hpp:1087
nstd::string messageServerId
消息服务器 ID
Definition v2_nim_def_struct.hpp:1081
群摘要
Definition v2_nim_def_struct.hpp:1526
bool operator==(const V2NIMTeamRefer &other) const
Definition v2_nim_internal.hpp:28
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1530
bool operator<(const V2NIMTeamRefer &other) const
Definition v2_nim_internal.hpp:25
static std::string referToKey(V2NIMTeamRefer refer)
Definition v2_nim_internal.hpp:31
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1528
static V2NIMTeamRefer keyToRefer(std::string key)
Definition v2_nim_internal.hpp:34
size_t hash_value() const
Definition v2_nim_def_struct.hpp:1537
群信息检索参数
Definition v2_nim_def_struct.hpp:1704
nstd::optional< nstd::string > nextToken
起始位置,首次传“”, 后续传上次返回的nextToken,该参数仅云端检索有效
Definition v2_nim_def_struct.hpp:1714
nstd::optional< nstd::vector< V2NIMTeamType > > teamTypes
匹配群类型,为空则匹配所有类型
Definition v2_nim_def_struct.hpp:1710
nstd::vector< nstd::string > keywordList
要查询的关键字列表,最多支持 5 个
Definition v2_nim_def_struct.hpp:1706
nstd::optional< V2NIMSearchKeywordMathType > keywordMatchType
指定关键字列表匹配类型,见 V2NIMSearchKeywordMathType,默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition v2_nim_def_struct.hpp:1708
nstd::optional< uint32_t > limit
搜索的数量限制,默认为 20,不建议超过 100,该参数仅云端检索有效
Definition v2_nim_def_struct.hpp:1712
Definition v2_nim_def_struct.hpp:605
nstd::optional< nstd::string > excludeMessageServerId
锚点消息 ServerId ,该消息必须处于端点,暨消息时间必须等于 beginTime 或 endTime
Definition v2_nim_def_struct.hpp:613
V2NIMMessageRefer messageRefer
需要查询的消息引用,如果该消息为根消息,则参数为当前消息
Definition v2_nim_def_struct.hpp:607
nstd::optional< uint64_t > endTime
查询结束时间
Definition v2_nim_def_struct.hpp:611
nstd::optional< uint64_t > beginTime
查询开始时间,小于等于 endTime
Definition v2_nim_def_struct.hpp:609
nstd::optional< V2NIMQueryDirection > direction
消息查询方向,如果其它参数都不填
Definition v2_nim_def_struct.hpp:617
nstd::optional< uint32_t > limit
每次查询条数,默认 50
Definition v2_nim_def_struct.hpp:615
Definition v2_nim_def_struct.hpp:855
nstd::vector< V2NIMMessage > replyList
消息回复列表
Definition v2_nim_def_struct.hpp:863
V2NIMMessage message
根消息
Definition v2_nim_def_struct.hpp:857
uint32_t replyCount
获取 thread 聊天里的总回复数
Definition v2_nim_def_struct.hpp:861
uint64_t timestamp
thread 聊天里最后一条消息的时间戳
Definition v2_nim_def_struct.hpp:859
@biref V2NIMTransportLayerSecurityOption TLS 配置
Definition v2_nim_def_struct.hpp:27
bool skipHostCertCheck
是否跳过主机证书检查,默认不跳过
Definition v2_nim_def_struct.hpp:33
nstd::optional< nstd::string > clientCAFilePath
自定义 SSL CA 证书位置,pem 格式,留空使用内置默认证书
Definition v2_nim_def_struct.hpp:35
bool sslConnection
是否启用 SSL/TLS 加密,默认启用,目前仅在使用 WebSocket 链接时使用
Definition v2_nim_def_struct.hpp:29
bool allowSelfSignedCert
是否允许自签证书,默认不允许
Definition v2_nim_def_struct.hpp:31
取消订阅选项
Definition v2_nim_def_struct.hpp:2679
nstd::optional< nstd::vector< nstd::string > > accountIds
取消订阅的成员列表,为空则表示取消所有订阅的成员,否则取消指定的成员。单次数量不超过 100,超过默认截取前 100
Definition v2_nim_def_struct.hpp:2681
更新本地消息参数
Definition v2_nim_def_struct.hpp:2978
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:2988
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:2984
nstd::optional< nstd::string > localExtension
消息本地扩展
Definition v2_nim_def_struct.hpp:2986
nstd::optional< nstd::string > text
消息内容
Definition v2_nim_def_struct.hpp:2982
nstd::optional< uint32_t > subType
消息子类型,需要 >= 0
Definition v2_nim_def_struct.hpp:2980
更新群成员昵称参数
Definition v2_nim_def_struct.hpp:1750
nstd::string teamNick
昵称
Definition v2_nim_def_struct.hpp:1754
nstd::string accountId
群成员 ID
Definition v2_nim_def_struct.hpp:1752
nstd::optional< V2NIMAntispamConfig > antispamConfig
昵称相关的安全配置
Definition v2_nim_def_struct.hpp:1756
Definition v2_nim_def_struct.hpp:1740
nstd::optional< nstd::string > teamNick
设置的群昵称
Definition v2_nim_def_struct.hpp:1742
nstd::optional< V2NIMAntispamConfig > antispamConfig
昵称相关的安全配置
Definition v2_nim_def_struct.hpp:1746
nstd::optional< nstd::string > serverExtension
设置的群成员扩展字段
Definition v2_nim_def_struct.hpp:1744
Definition v2_nim_def_struct.hpp:254
nstd::optional< V2NIMTeamJoinMode > joinMode
申请入群模式
Definition v2_nim_def_struct.hpp:268
nstd::optional< V2NIMTeamAgreeMode > agreeMode
被邀请人入群模式
Definition v2_nim_def_struct.hpp:270
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:264
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:260
nstd::optional< V2NIMTeamUpdateExtensionMode > updateExtensionMode
群组扩展字段修改模式
Definition v2_nim_def_struct.hpp:276
nstd::optional< V2NIMTeamInviteMode > inviteMode
群组邀请模式
Definition v2_nim_def_struct.hpp:272
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:258
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:262
nstd::optional< nstd::string > name
新修改群组名称
Definition v2_nim_def_struct.hpp:256
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:266
nstd::optional< V2NIMTeamUpdateInfoMode > updateInfoMode
群组资料修改模式
Definition v2_nim_def_struct.hpp:274
群组信息更新信息
Definition v2_nim_def_struct.hpp:280
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由 openApi 设置
Definition v2_nim_def_struct.hpp:284
nstd::optional< V2NIMTeamChatBannedMode > chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:282
Definition v2_nim_def_struct.hpp:2350
nstd::string filePath
文件地址
Definition v2_nim_def_struct.hpp:2352
nstd::string sceneName
场景名
Definition v2_nim_def_struct.hpp:2354
Definition v2_nim_def_struct.hpp:2357
V2NIMUploadFileParams uploadParams
上传任务参数
Definition v2_nim_def_struct.hpp:2361
nstd::string taskId
上传任务 ID
Definition v2_nim_def_struct.hpp:2359
Definition v2_nim_def_struct.hpp:1798
nstd::optional< nstd::string > birthday
用户生日
Definition v2_nim_def_struct.hpp:1810
nstd::optional< nstd::string > avatar
用户头像
Definition v2_nim_def_struct.hpp:1804
uint64_t createTime
用户资料创建时间
Definition v2_nim_def_struct.hpp:1818
nstd::optional< nstd::string > email
用户邮箱
Definition v2_nim_def_struct.hpp:1808
uint64_t updateTime
用户资料更新时间
Definition v2_nim_def_struct.hpp:1820
nstd::string accountId
账号 ID
Definition v2_nim_def_struct.hpp:1800
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1816
nstd::optional< nstd::string > name
用户昵称
Definition v2_nim_def_struct.hpp:1802
nstd::optional< uint32_t > gender
用户性别
Definition v2_nim_def_struct.hpp:1814
nstd::optional< nstd::string > mobile
用户手机号
Definition v2_nim_def_struct.hpp:1812
nstd::optional< nstd::string > sign
用户签名
Definition v2_nim_def_struct.hpp:1806
Definition v2_nim_def_struct.hpp:2124
nstd::string senderAvatar
发送方头像
Definition v2_nim_def_struct.hpp:2130
nstd::string senderNick
发送方昵称
Definition v2_nim_def_struct.hpp:2128
nstd::string senderExtension
发送方扩展字段
Definition v2_nim_def_struct.hpp:2132
uint64_t userInfoTimestamp
消息发送者 uinfo 的最后更新时间
Definition v2_nim_def_struct.hpp:2126
用户搜索选项
Definition v2_nim_def_struct.hpp:1843
bool searchMobile
是否搜索手机号
Definition v2_nim_def_struct.hpp:1851
bool searchAccountId
是否搜索用户账号
Definition v2_nim_def_struct.hpp:1849
bool searchName
是否搜索用户昵称
Definition v2_nim_def_struct.hpp:1847
nstd::string keyword
搜索关键字
Definition v2_nim_def_struct.hpp:1845
事件订阅用户状态
Definition v2_nim_def_struct.hpp:2719
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition v2_nim_def_struct.hpp:2733
uint32_t statusType
用户状态类型
Definition v2_nim_def_struct.hpp:2723
time_t publishTime
用户发布状态的发布时间(服务器时间)
Definition v2_nim_def_struct.hpp:2727
nstd::string accountId
用户账号 ID
Definition v2_nim_def_struct.hpp:2721
nstd::optional< nstd::string > uniqueId
每次发布时会生成一个唯一 ID,发布自定义事件时会生成该参数,如果 ID 相同则表示同一个事件
Definition v2_nim_def_struct.hpp:2729
V2NIMLoginClientType clientType
用户发布状态对应的终端 V2NIMLoginClientType
Definition v2_nim_def_struct.hpp:2725
nstd::optional< uint32_t > duration
事件的有效期
Definition v2_nim_def_struct.hpp:2731
nstd::optional< nstd::string > serverExtension
获取预留状态中的配置信息,由服务端填入 JSON array 格式
Definition v2_nim_def_struct.hpp:2735
用户状态订阅结果
Definition v2_nim_def_struct.hpp:2709
time_t subscribeTime
用户状态发布时的时间
Definition v2_nim_def_struct.hpp:2715
nstd::string accountId
查询的用户账号
Definition v2_nim_def_struct.hpp:2711
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 30 天
Definition v2_nim_def_struct.hpp:2713
Definition v2_nim_def_struct.hpp:1823
nstd::optional< nstd::string > email
用户邮箱
Definition v2_nim_def_struct.hpp:1831
nstd::optional< nstd::string > mobile
用户手机号
Definition v2_nim_def_struct.hpp:1835
nstd::optional< uint32_t > gender
用户性别
Definition v2_nim_def_struct.hpp:1837
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1839
nstd::optional< nstd::string > sign
用户签名
Definition v2_nim_def_struct.hpp:1829
nstd::optional< nstd::string > avatar
用户头像
Definition v2_nim_def_struct.hpp:1827
nstd::optional< nstd::string > birthday
用户生日
Definition v2_nim_def_struct.hpp:1833
nstd::optional< nstd::string > name
用户昵称
Definition v2_nim_def_struct.hpp:1825
Definition v2_nim_def_struct.hpp:1510
nstd::string voiceUrl
语音 url, 若为空则根据 voicePath 自动上传
Definition v2_nim_def_struct.hpp:1514
nstd::string sampleRate
采样率
Definition v2_nim_def_struct.hpp:1518
nstd::string voicePath
本地语音文件路径, 若为空则使用 url
Definition v2_nim_def_struct.hpp:1512
nstd::string mimeType
音频类型, aac, wav, mp3, amr等
Definition v2_nim_def_struct.hpp:1516
nstd::string sceneName
文件存储场景
Definition v2_nim_def_struct.hpp:1522
uint64_t duration
语音时长, 单位毫秒
Definition v2_nim_def_struct.hpp:1520