1#ifndef V2_NIM_DEF_STRUCT_H
2#define V2_NIM_DEF_STRUCT_H
2067 std::vector<V2NIMClientAntispamThesaurusItem>
items;
Definition ne_stl_continuous_container.h:15
Definition ne_stl_smart_ptr.h:30
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:1191
@ V2NIM_KICKED_OFFLINE_REASON_CLIENT_EXCLUSIVE
多端登录互踢
Definition v2_nim_def_enum.hpp:1193
V2NIMTeamUpdateExtensionMode
Definition v2_nim_def_enum.hpp:1318
@ V2NIM_TEAM_UPDATE_EXTENSION_MODE_MANAGER
群主/管理员可以修改群组扩展字段
Definition v2_nim_def_enum.hpp:1320
V2NIMMessageQuickCommentType
Definition v2_nim_def_enum.hpp:1101
@ V2NIM_MESSAGE_QUICK_COMMENT_TYPE_ADD
添加快捷评论
Definition v2_nim_def_enum.hpp:1103
V2NIMSignallingChannelType
Definition v2_nim_def_enum.hpp:1544
@ V2NIM_SIGNALLING_CHANNEL_TYPE_UNKNOWN
未知频道类型
Definition v2_nim_def_enum.hpp:1546
static const uint32_t V2NIM_DEFAULT_LOG_RESERVE_DAYS
Definition v2_nim_def_enum.hpp:1615
V2NIMProxyRequestMethod
Definition v2_nim_def_enum.hpp:1588
static const uint32_t V2NIM_DEFAULT_JOIN_ACTION_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1617
V2NIMChatroomMemberRole
Definition v2_nim_def_enum.hpp:1415
@ V2NIM_CHATROOM_MEMBER_ROLE_NORMAL
普通成员
Definition v2_nim_def_enum.hpp:1417
V2NIMMessageAttachmentUploadState
Definition v2_nim_def_enum.hpp:969
@ V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_UNKNOWN
未知, 不存在附件或不需要上传的附件
Definition v2_nim_def_enum.hpp:971
V2NIMTeamUpdateInfoMode
Definition v2_nim_def_enum.hpp:1302
@ V2NIM_TEAM_UPDATE_INFO_MODE_MANAGER
群主/管理员可以修改群组资料
Definition v2_nim_def_enum.hpp:1304
V2NIMMessageRevokeType
Definition v2_nim_def_enum.hpp:1124
@ V2NIM_MESSAGE_REVOKE_TYPE_UNDEFINED
未定义
Definition v2_nim_def_enum.hpp:1126
V2NIMSortOrder
Definition v2_nim_def_enum.hpp:1108
@ V2NIM_SORT_ORDER_DESC
按时间降序排序
Definition v2_nim_def_enum.hpp:1110
V2NIMClientAntispamThesaurusMatchType
Definition v2_nim_def_enum.hpp:1265
@ V2NIM_CLIENT_ANTISPAM_THESAURUS_MATCH_TYPE_WORD
Definition v2_nim_def_enum.hpp:1266
V2NIMDataSyncLevel
Definition v2_nim_def_enum.hpp:1220
@ V2NIM_DATA_SYNC_LEVEL_FULL
完全同步
Definition v2_nim_def_enum.hpp:1222
V2NIMAIModelRoleType
Definition v2_nim_def_enum.hpp:1524
V2NIMAsymmetricEncryptionAlgorithm
Definition v2_nim_def_enum.hpp:864
@ V2NIM_ASYMMETRIC_ENCRYPTION_ALGORITHM_RSA
RSA
Definition v2_nim_def_enum.hpp:866
V2NIMClientAntispamOperateType
Definition v2_nim_def_enum.hpp:1254
@ V2NIM_CLIENT_ANTISPAM_OPERATE_NONE
无操作
Definition v2_nim_def_enum.hpp:1256
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:1627
static const uint32_t V2NIM_DEFAULT_FRIEND_APPLICATION_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1618
V2NIMFriendAddApplicationStatus
Definition v2_nim_def_enum.hpp:1388
@ V2NIM_FRIEND_ADD_APPLICATION_STATUS_INIT
未处理
Definition v2_nim_def_enum.hpp:1390
V2NIMAIModelType
Definition v2_nim_def_enum.hpp:1533
V2NIMChatroomQueueLevelMode
Definition v2_nim_def_enum.hpp:1408
@ V2NIM_CHATROOM_QUEUE_LEVEL_MODE_ANY
所有人都有权限操作
Definition v2_nim_def_enum.hpp:1410
V2NIMMessageAttachmentType
Definition v2_nim_def_enum.hpp:1491
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_UNIVERSAL
通用
Definition v2_nim_def_enum.hpp:1493
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_LOCATION
位置
Definition v2_nim_def_enum.hpp:1501
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_AUDIO
语音
Definition v2_nim_def_enum.hpp:1497
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_TEAM_NOTIFICATION
群通知
Definition v2_nim_def_enum.hpp:1503
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ENTER_NOTIFICATION
聊天室成员进入
Definition v2_nim_def_enum.hpp:1517
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_CHAT_BANNED_NOTIFICATION
聊天室禁言
Definition v2_nim_def_enum.hpp:1515
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_FILE
文件
Definition v2_nim_def_enum.hpp:1505
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CALL
话单
Definition v2_nim_def_enum.hpp:1507
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_QUEUE_NOTIFICATION
聊天室队列变更
Definition v2_nim_def_enum.hpp:1513
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ROLE_UPDATE_NOTIFICATION
聊天室成员角色变更
Definition v2_nim_def_enum.hpp:1519
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_VIDEO
视频
Definition v2_nim_def_enum.hpp:1499
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_NOTIFICATION
聊天室通知
Definition v2_nim_def_enum.hpp:1509
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CUSTOM
自定义消息
Definition v2_nim_def_enum.hpp:1521
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MESSAGE_REVOKE_NOTIFICATION
聊天室消息撤回
Definition v2_nim_def_enum.hpp:1511
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_IMAGE
图片
Definition v2_nim_def_enum.hpp:1495
V2NIMFCSAuthType
Definition v2_nim_def_enum.hpp:900
@ V2NIM_FCS_AUTH_TYPE_NONE
无鉴权
Definition v2_nim_def_enum.hpp:902
V2NIMTeamJoinActionStatus
Definition v2_nim_def_enum.hpp:1377
@ V2NIM_TEAM_JOIN_ACTION_STATUS_INIT
未处理
Definition v2_nim_def_enum.hpp:1379
V2NIMSDKLogLevel
Definition v2_nim_def_enum.hpp:887
@ V2NIM_SDK_LOG_LEVEL_APP
应用
Definition v2_nim_def_enum.hpp:895
static const uint32_t V2NIM_DEFAULT_SEARCH_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1623
static const uint32_t V2NIM_DEFAULT_SEARCH_LOCAL_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1624
V2NIMLastMessageState
Definition v2_nim_def_enum.hpp:960
@ V2NIM_MESSAGE_STATE_DEFAULT
默认
Definition v2_nim_def_enum.hpp:962
static const uint32_t V2NIM_DEFAULT_CHATROOM_QUERY_LIMIT
Definition v2_nim_def_enum.hpp:1622
V2NIMTeamChatBannedMode
Definition v2_nim_def_enum.hpp:1309
@ V2NIM_TEAM_CHAT_BANNED_MODE_NONE
不禁言, 群组成员可以自由发言
Definition v2_nim_def_enum.hpp:1311
V2NIMTeamJoinActionType
Definition v2_nim_def_enum.hpp:1343
@ V2NIM_TEAM_JOIN_ACTION_TYPE_APPLICATION
申请入群
Definition v2_nim_def_enum.hpp:1345
V2NIMTeamAgreeMode
Definition v2_nim_def_enum.hpp:1288
@ V2NIM_TEAM_AGREE_MODE_AUTH
需要被邀请人同意
Definition v2_nim_def_enum.hpp:1290
static const char * V2NIM_STORAGE_SCENE_NAME_DEFAULT_IM
Definition v2_nim_def_enum.hpp:1640
V2NIMChatroomKickedReason
Definition v2_nim_def_enum.hpp:1430
@ V2NIM_CHATROOM_KICKED_REASON_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:1432
V2NIMLoginClientType
Definition v2_nim_def_enum.hpp:1159
@ V2NIM_LOGIN_CLIENT_TYPE_UNKNOWN
未知类型
Definition v2_nim_def_enum.hpp:1161
V2NIMMessageClientAntispamOperatorType
Definition v2_nim_def_enum.hpp:1139
@ V2NIM_MESSAGE_CLIENT_ANTISPAM_OPERATOR_NONE
无操作
Definition v2_nim_def_enum.hpp:1141
V2NIMMessageType
Definition v2_nim_def_enum.hpp:924
@ V2NIM_MESSAGE_TYPE_TEXT
文本
Definition v2_nim_def_enum.hpp:926
V2NIMDownloadAttachmentType
Definition v2_nim_def_enum.hpp:1482
@ V2NIM_DOWNLOAD_ATTACHMENT_TYPE_SOURCE
原始资源,支持全部有附件的类型
Definition v2_nim_def_enum.hpp:1484
V2NIMTeamType
Definition v2_nim_def_enum.hpp:1270
@ V2NIM_TEAM_TYPE_NORMAL
高级群
Definition v2_nim_def_enum.hpp:1274
V2NIMDataSyncType
Definition v2_nim_def_enum.hpp:1227
@ V2NIM_DATA_SYNC_MAIN
同步主数据
Definition v2_nim_def_enum.hpp:1229
V2NIMFriendAddMode
Definition v2_nim_def_enum.hpp:1370
@ V2NIM_FRIEND_MODE_TYPE_ADD
直接添加对方为好友
Definition v2_nim_def_enum.hpp:1372
V2NIMSymmetricEncryptionAlgorithm
Definition v2_nim_def_enum.hpp:871
@ V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_RC4
RC4
Definition v2_nim_def_enum.hpp:873
static const uint32_t V2NIM_DEFAULT_MESSAGE_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1616
V2NIMSignallingEventType
信令频道事件类型
Definition v2_nim_def_enum.hpp:1556
static const uint32_t V2NIM_DEFAULT_SUBSCRIBE_DURATION
Definition v2_nim_def_enum.hpp:1628
V2NIMTeamInviteMode
Definition v2_nim_def_enum.hpp:1295
@ V2NIM_TEAM_INVITE_MODE_MANAGER
群主, 管理员可以邀请其他人入群
Definition v2_nim_def_enum.hpp:1297
V2NIMDataSyncState
Definition v2_nim_def_enum.hpp:1236
@ V2NIM_DATA_SYNC_STATE_WAITING
等待同步
Definition v2_nim_def_enum.hpp:1238
V2NIMMessageAIStatus
Definition v2_nim_def_enum.hpp:1115
@ V2NIM_MESSAGE_AI_STATUS_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:1117
V2NIMConversationType
Definition v2_nim_def_enum.hpp:913
@ V2NIM_CONVERSATION_TYPE_UNKNOWN
未知
Definition v2_nim_def_enum.hpp:915
static const uint32_t V2NIM_DEFAULT_COLLECTION_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1619
V2NIMTeamJoinMode
Definition v2_nim_def_enum.hpp:1279
@ V2NIM_TEAM_JOIN_MODE_APPLY
需申请, 群主或管理同意后加入
Definition v2_nim_def_enum.hpp:1283
V2NIMMessageNotificationType
Definition v2_nim_def_enum.hpp:980
@ V2NIM_MESSAGE_NOTIFICATION_TYPE_TEAM_INVITE
群拉人
Definition v2_nim_def_enum.hpp:982
V2NIMClearHistoryMode
删除消息模式
Definition v2_nim_def_enum.hpp:1608
@ V2NIM_CLEAR_HISTORY_MODE_ALL
同时删除云端和本地
Definition v2_nim_def_enum.hpp:1610
V2NIMLoginAuthType
Definition v2_nim_def_enum.hpp:1150
@ V2NIM_LOGIN_AUTH_TYPE_DEFAULT
默认
Definition v2_nim_def_enum.hpp:1152
V2NIMQueryDirection
Definition v2_nim_def_enum.hpp:1094
@ V2NIM_QUERY_DIRECTION_DESC
按时间降序查询
Definition v2_nim_def_enum.hpp:1096
static const uint64_t DEFAULT_PROTOCOL_TIMEOUT
Definition v2_nim_def_enum.hpp:1630
V2NIMMessageSendingState
Definition v2_nim_def_enum.hpp:949
@ V2NIM_MESSAGE_SENDING_STATE_UNKNOWN
未知, 如果消息不是从这个端发送的
Definition v2_nim_def_enum.hpp:951
V2NIMChatroomMessageNotificationType
Definition v2_nim_def_enum.hpp:1027
@ V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_ENTER
成员进入聊天室
Definition v2_nim_def_enum.hpp:1029
V2NIMIPProtocolVersion
Definition v2_nim_def_enum.hpp:855
@ V2NIM_IP_PROTOCOL_VERSION_IPV4
IPv4
Definition v2_nim_def_enum.hpp:859
static const uint32_t V2NIM_DEFAULT_TEAM_MEMBER_LIST_LIMIT
Definition v2_nim_def_enum.hpp:1621
V2NIMSQLCipherVersion
Definition v2_nim_def_enum.hpp:880
@ V2NIM_SQLCIPHER_VERSION_4
SQLCipher 4
Definition v2_nim_def_enum.hpp:884
V2NIMMessagePinState
Definition v2_nim_def_enum.hpp:1085
@ V2NIM_MESSAGE_PIN_STEATE_NOT_PINNED
未 pin
Definition v2_nim_def_enum.hpp:1087
static const uint64_t DEFAULT_LINK_TIMEOUT
Definition v2_nim_def_enum.hpp:1629
V2NIMSearchKeywordMathType
搜索关键字匹配条件
Definition v2_nim_def_enum.hpp:1600
@ V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
或
Definition v2_nim_def_enum.hpp:1602
V2NIMChatroomQueueChangeType
Definition v2_nim_def_enum.hpp:1068
Definition ne_stl_optional.h:16
Definition ne_stl_bind.h:132
调用大模型的请求内容
Definition v2_nim_def_struct.hpp:602
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition v2_nim_def_struct.hpp:606
nstd::string msg
请求/响应的文本内容
Definition v2_nim_def_struct.hpp:604
Definition v2_nim_def_struct.hpp:609
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition v2_nim_def_struct.hpp:615
nstd::string msg
上下文的内容
Definition v2_nim_def_struct.hpp:613
V2NIMAIModelRoleType role
上下文内容的角色
Definition v2_nim_def_struct.hpp:611
Definition v2_nim_def_struct.hpp:785
nstd::optional< V2NIMAIModelCallContent > content
请求 AI 的回复
Definition v2_nim_def_struct.hpp:793
nstd::string accountId
数字人的账号 ID
Definition v2_nim_def_struct.hpp:789
nstd::string requestId
本次响应的标识
Definition v2_nim_def_struct.hpp:791
uint32_t code
AI 响应的状态码
Definition v2_nim_def_struct.hpp:787
Definition v2_nim_def_struct.hpp:2095
nstd::optional< nstd::string > temperature
取值范围(0, 2), 用于控制随机性和多样性的程度。
Definition v2_nim_def_struct.hpp:2107
nstd::string model
具体大模型版本模型名
Definition v2_nim_def_struct.hpp:2097
nstd::optional< uint32_t > maxTokens
模型最大tokens数量
Definition v2_nim_def_struct.hpp:2103
nstd::optional< nstd::string > topP
取值范围(0, 1), 生成时,核采样方法的概率阈值。
Definition v2_nim_def_struct.hpp:2105
nstd::string prompt
提示词
Definition v2_nim_def_struct.hpp:2099
nstd::optional< nstd::vector< nstd::string > > promptKeys
提示词对应的变量
Definition v2_nim_def_struct.hpp:2101
Definition v2_nim_def_struct.hpp:618
nstd::optional< nstd::string > prompt
提示词
Definition v2_nim_def_struct.hpp:620
nstd::optional< int32_t > maxTokens
模型最大 tokens 数量
Definition v2_nim_def_struct.hpp:622
nstd::optional< double > temperature
取值范围 (0, 2), 用于控制随机性和多样性的程度。
Definition v2_nim_def_struct.hpp:626
nstd::optional< double > topP
取值范围 (0, 1), 生成时, 核采样方法的概率阈值。
Definition v2_nim_def_struct.hpp:624
Definition v2_nim_def_struct.hpp:2110
V2NIMAIModelConfig modelConfig
模型相关配置文件
Definition v2_nim_def_struct.hpp:2114
V2NIMAIModelType modelType
模型选择
Definition v2_nim_def_struct.hpp:2112
Definition v2_nim_def_struct.hpp:1094
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1100
uint32_t collectionType
收藏类型
Definition v2_nim_def_struct.hpp:1096
nstd::string collectionData
收藏数据
Definition v2_nim_def_struct.hpp:1098
nstd::optional< nstd::string > uniqueId
去重唯一 ID,如果 ID 相同,则不会新增收藏,只更新之前的收藏内容
Definition v2_nim_def_struct.hpp:1102
Definition v2_nim_def_struct.hpp:1552
nstd::string antispamBusinessId
易盾业务 ID
Definition v2_nim_def_struct.hpp:1554
Definition v2_nim_def_struct.hpp:96
bool disableAppNap
是否禁用 macOS 下的 App Nap 功能
Definition v2_nim_def_struct.hpp:110
bool reduceUnreadOnMessageRecall
收到撤回消息通知时是否减少指定会话的未读计数
Definition v2_nim_def_struct.hpp:116
uint32_t sdkType
Definition v2_nim_def_struct.hpp:120
nstd::string customTag
登录自定义信息, 最大 32 个字符
Definition v2_nim_def_struct.hpp:104
uint32_t customClientType
自定义客户端类型
Definition v2_nim_def_struct.hpp:102
bool teamNotificationBadge
群通知类消息是否计入未读数
Definition v2_nim_def_struct.hpp:114
uint32_t logReserveDays
日志保留天数
Definition v2_nim_def_struct.hpp:106
nstd::optional< nstd::string > compassDataEndpoint
云信指南针数据上报地址,为空则使用默认地址
Definition v2_nim_def_struct.hpp:118
bool enableCompass
云信指南针数据上报开关
Definition v2_nim_def_struct.hpp:112
bool useHttpdns
是否使用 httpdns
Definition v2_nim_def_struct.hpp:100
bool useHttps
是否使用 https
Definition v2_nim_def_struct.hpp:98
nstd::function< void(nstd::string log)> logCallback
Definition v2_nim_def_struct.hpp:122
V2NIMSDKLogLevel sdkLogLevel
SDK日志级别
Definition v2_nim_def_struct.hpp:108
Definition v2_nim_def_struct.hpp:774
uint64_t id
广播通知 ID
Definition v2_nim_def_struct.hpp:776
uint64_t timestamp
广播通知时间戳
Definition v2_nim_def_struct.hpp:780
nstd::string content
广播通知内容
Definition v2_nim_def_struct.hpp:782
nstd::string senderId
广播通知发送者账号
Definition v2_nim_def_struct.hpp:778
聊天室自定义消息附件解析器
Definition v2_nim_def_struct.hpp:2052
virtual ~V2NIMChatRoomMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition v2_nim_def_struct.hpp:1831
uint64_t pollingInterval
Definition v2_nim_def_struct.hpp:1835
uint64_t timestamp
Definition v2_nim_def_struct.hpp:1834
uint32_t decryptType
Definition v2_nim_def_struct.hpp:1836
std::string decryptKey
Definition v2_nim_def_struct.hpp:1837
bool enabled
Definition v2_nim_def_struct.hpp:1832
std::vector< std::string > cdnUrls
Definition v2_nim_def_struct.hpp:1833
uint64_t pollingTimeout
Definition v2_nim_def_struct.hpp:1838
Definition v2_nim_def_struct.hpp:411
V2NIMChatroomChatBannedNotificationAttachment()
Definition v2_nim_def_struct.hpp:412
bool tempChatBanned
成员是否被临时禁言
Definition v2_nim_def_struct.hpp:416
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition v2_nim_def_struct.hpp:418
bool chatBanned
成员是否被禁言
Definition v2_nim_def_struct.hpp:414
Definition v2_nim_def_struct.hpp:149
nstd::string roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:153
uint32_t clientType
进入的终端类型
Definition v2_nim_def_struct.hpp:157
nstd::string roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:151
uint64_t enterTime
用户进入聊天室的时间点
Definition v2_nim_def_struct.hpp:155
Definition v2_nim_def_struct.hpp:1779
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:1785
V2NIMAntispamConfig antispamConfig
反垃圾配置信息
Definition v2_nim_def_struct.hpp:1805
nstd::string accountId
账号 ID
Definition v2_nim_def_struct.hpp:1781
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:1787
nstd::string token
静态 token
Definition v2_nim_def_struct.hpp:1783
nstd::optional< V2NIMChatroomLocationConfig > locationConfig
进入聊天室空间位置信息配置
Definition v2_nim_def_struct.hpp:1803
V2NIMChatroomLinkProvider linkProvider
获取聊天室 link 链接地址
Definition v2_nim_def_struct.hpp:1795
uint64_t timeout
登录超时, 单位毫秒
Definition v2_nim_def_struct.hpp:1789
bool anonymousMode
匿名模式
Definition v2_nim_def_struct.hpp:1793
V2NIMChatroomLoginOption loginOption
聊天室登录相关信息
Definition v2_nim_def_struct.hpp:1791
V2NIMChatroomTagConfig tagConfig
进入聊天室标签信息配置
Definition v2_nim_def_struct.hpp:1801
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition v2_nim_def_struct.hpp:1799
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1797
Definition v2_nim_def_struct.hpp:1841
V2NIMChatroomInfo chatroom
聊天室信息
Definition v2_nim_def_struct.hpp:1843
V2NIMChatroomMember selfMember
用户信息
Definition v2_nim_def_struct.hpp:1845
Definition v2_nim_def_struct.hpp:1808
nstd::string serverExtension
聊天室扩展字段
Definition v2_nim_def_struct.hpp:1820
nstd::string announcement
聊天室公告
Definition v2_nim_def_struct.hpp:1814
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:1810
bool isValidRoom
聊天室是否有效
Definition v2_nim_def_struct.hpp:1818
bool chatBanned
聊天室禁言状态
Definition v2_nim_def_struct.hpp:1828
nstd::string roomName
聊天室名称
Definition v2_nim_def_struct.hpp:1812
nstd::string creatorAccountId
聊天室创建者账号 ID
Definition v2_nim_def_struct.hpp:1824
V2NIMChatroomQueueLevelMode queueLevelMode
聊天室队列操作权限模式
Definition v2_nim_def_struct.hpp:1822
uint32_t onlineUserCount
聊天室当前在线用户数量
Definition v2_nim_def_struct.hpp:1826
nstd::string liveUrl
视频直播拉流地址
Definition v2_nim_def_struct.hpp:1816
Definition v2_nim_def_struct.hpp:1848
nstd::string serverExtension
被踢扩展字段
Definition v2_nim_def_struct.hpp:1852
V2NIMChatroomKickedReason kickedReason
被踢原因
Definition v2_nim_def_struct.hpp:1850
Definition v2_nim_def_struct.hpp:1772
nstd::optional< double > distance
订阅的消息的距离
Definition v2_nim_def_struct.hpp:1776
V2NIMLocationInfo locationInfo
空间坐标信息
Definition v2_nim_def_struct.hpp:1774
Definition v2_nim_def_struct.hpp:1747
V2NIMLoginAuthType authType
认证模式
Definition v2_nim_def_struct.hpp:1749
V2NIMChatroomTokenProvider tokenProvider
token 获取回调
Definition v2_nim_def_struct.hpp:1751
V2NIMChatroomLoginExtensionProvider loginExtensionProvider
登陆扩展回调
Definition v2_nim_def_struct.hpp:1753
Definition v2_nim_def_struct.hpp:422
bool tempChatBanned
成员是否被临时禁言
Definition v2_nim_def_struct.hpp:427
bool chatBanned
成员是否被禁言
Definition v2_nim_def_struct.hpp:425
V2NIMChatroomMemberEnterNotificationAttachment()
Definition v2_nim_def_struct.hpp:423
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition v2_nim_def_struct.hpp:429
Definition v2_nim_def_struct.hpp:160
nstd::string accountId
成员账号 ID
Definition v2_nim_def_struct.hpp:164
nstd::string notifyTargetTags
登录登出通知标签
Definition v2_nim_def_struct.hpp:188
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:192
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:162
bool valid
是否有效
Definition v2_nim_def_struct.hpp:194
bool isOnline
用户是否在线
Definition v2_nim_def_struct.hpp:176
uint64_t enterTime
用户进入聊天室的时间点
Definition v2_nim_def_struct.hpp:190
nstd::vector< V2NIMChatroomEnterInfo > multiEnterInfo
多端登录信息
Definition v2_nim_def_struct.hpp:196
uint64_t tempChatBannedDuration
临时禁言时长, 单位秒
Definition v2_nim_def_struct.hpp:184
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition v2_nim_def_struct.hpp:172
bool chatBanned
是否禁言
Definition v2_nim_def_struct.hpp:180
nstd::optional< nstd::string > serverExtension
聊天室成员扩展字段
Definition v2_nim_def_struct.hpp:174
nstd::vector< nstd::string > tags
登录标签
Definition v2_nim_def_struct.hpp:186
bool tempChatBanned
是否临时禁言
Definition v2_nim_def_struct.hpp:182
bool blocked
是否在黑名单中
Definition v2_nim_def_struct.hpp:178
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition v2_nim_def_struct.hpp:170
nstd::optional< uint32_t > memberLevel
成员等级, 0 表示未设置
Definition v2_nim_def_struct.hpp:168
V2NIMChatroomMemberRole memberRole
聊天室成员角色
Definition v2_nim_def_struct.hpp:166
Definition v2_nim_def_struct.hpp:1959
nstd::vector< V2NIMChatroomMember > memberList
拉取的成员列表
Definition v2_nim_def_struct.hpp:1965
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:1963
nstd::string pageToken
下一次查询的偏移量
Definition v2_nim_def_struct.hpp:1961
Definition v2_nim_def_struct.hpp:1944
bool onlyBlocked
是否只返回黑名单成员
Definition v2_nim_def_struct.hpp:1948
nstd::string pageToken
偏移量
Definition v2_nim_def_struct.hpp:1954
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1956
bool onlyOnline
是否只查询在线成员
Definition v2_nim_def_struct.hpp:1952
bool onlyChatBanned
是否只返回禁言用户
Definition v2_nim_def_struct.hpp:1950
nstd::vector< V2NIMChatroomMemberRole > memberRoles
需要查询的成员类型
Definition v2_nim_def_struct.hpp:1946
Definition v2_nim_def_struct.hpp:433
V2NIMChatroomMemberRoleUpdateAttachment()
Definition v2_nim_def_struct.hpp:434
V2NIMChatroomMember currentMember
当前的成员信息
Definition v2_nim_def_struct.hpp:438
V2NIMChatroomMemberRole previousRole
之前的角色类型
Definition v2_nim_def_struct.hpp:436
Definition v2_nim_def_struct.hpp:1979
nstd::optional< uint32_t > memberLevel
设置用户等级
Definition v2_nim_def_struct.hpp:1983
V2NIMChatroomMemberRole memberRole
设置的成员角色
Definition v2_nim_def_struct.hpp:1981
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition v2_nim_def_struct.hpp:1985
Definition v2_nim_def_struct.hpp:1866
bool highPriority
是否是高优先级消息
Definition v2_nim_def_struct.hpp:1870
bool historyEnabled
是否需要在服务端保存历史消息
Definition v2_nim_def_struct.hpp:1868
Definition v2_nim_def_struct.hpp:1873
nstd::string text
消息内容
Definition v2_nim_def_struct.hpp:1895
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:1903
V2NIMMessageSendingState sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:1889
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition v2_nim_def_struct.hpp:1899
V2NIMMessageType messageType
消息类型
Definition v2_nim_def_struct.hpp:1891
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:1905
uint32_t subType
消息子类型
Definition v2_nim_def_struct.hpp:1893
V2NIMLoginClientType senderClientType
消息发送方客户端类型
Definition v2_nim_def_struct.hpp:1877
V2NIMMessageAttachmentUploadState attachmentUploadState
附件上传状态
Definition v2_nim_def_struct.hpp:1887
V2NIMChatroomMessageConfig messageConfig
聊天室消息配置
Definition v2_nim_def_struct.hpp:1909
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:1897
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:1907
nstd::string messageClientId
客户端消息 ID
Definition v2_nim_def_struct.hpp:1875
nstd::string roomId
聊天室 ID
Definition v2_nim_def_struct.hpp:1883
bool isSelf
消息发送者是否是自己
Definition v2_nim_def_struct.hpp:1885
V2NIMUserInfoConfig userInfoConfig
消息发送时的用户信息
Definition v2_nim_def_struct.hpp:1911
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition v2_nim_def_struct.hpp:1901
nstd::string senderId
消息发送者账号
Definition v2_nim_def_struct.hpp:1881
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition v2_nim_def_struct.hpp:1913
uint64_t createTime
消息时间, 单位毫秒
Definition v2_nim_def_struct.hpp:1879
Definition v2_nim_def_struct.hpp:1968
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1976
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1970
uint64_t beginTime
开始时间
Definition v2_nim_def_struct.hpp:1974
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition v2_nim_def_struct.hpp:1972
Definition v2_nim_def_struct.hpp:393
uint64_t messageTime
消息撤回时间
Definition v2_nim_def_struct.hpp:398
nstd::string messageClientId
消息撤回 ID
Definition v2_nim_def_struct.hpp:396
V2NIMChatroomMessageRevokeNotificationAttachment()
Definition v2_nim_def_struct.hpp:394
Definition v2_nim_def_struct.hpp:368
nstd::string operatorId
操作者
Definition v2_nim_def_struct.hpp:379
V2NIMChatroomNotificationAttachment()
Definition v2_nim_def_struct.hpp:369
nstd::optional< V2NIMChatroomMember > chatroomMember
Definition v2_nim_def_struct.hpp:389
nstd::vector< nstd::string > targetNicks
被操作成员的昵称列表
Definition v2_nim_def_struct.hpp:375
nstd::vector< nstd::string > tags
更新后的标签
Definition v2_nim_def_struct.hpp:385
nstd::optional< nstd::string > targetTag
被操作的标签
Definition v2_nim_def_struct.hpp:377
nstd::string operatorNick
操作者昵称
Definition v2_nim_def_struct.hpp:381
nstd::optional< nstd::string > notificationExtension
扩展字段
Definition v2_nim_def_struct.hpp:383
nstd::vector< nstd::string > targetIds
被操作的成员账号列表
Definition v2_nim_def_struct.hpp:373
V2NIMChatroomMessageNotificationType type
通知类型
Definition v2_nim_def_struct.hpp:371
nstd::optional< V2NIMChatroomUpdateParams > chatroomUpdateParams
Definition v2_nim_def_struct.hpp:387
聊天室队列元素
Definition v2_nim_def_struct.hpp:258
nstd::string value
元素的值
Definition v2_nim_def_struct.hpp:262
nstd::string key
元素的唯一 key,中文不建议超过 64 个字符,英文不建议超过 128 个字符
Definition v2_nim_def_struct.hpp:260
nstd::optional< nstd::string > nick
该元素所属于的账号的昵称
Definition v2_nim_def_struct.hpp:266
nstd::optional< nstd::string > extension
其他的扩展字段 JSON String
Definition v2_nim_def_struct.hpp:268
nstd::optional< nstd::string > accountId
该元素所属于的账号
Definition v2_nim_def_struct.hpp:264
Definition v2_nim_def_struct.hpp:402
nstd::vector< V2NIMChatroomQueueElement > elements
队列变更的内容
Definition v2_nim_def_struct.hpp:405
V2NIMChatroomQueueNotificationAttachment()
Definition v2_nim_def_struct.hpp:403
V2NIMChatroomQueueChangeType queueChangeType
队列更新类型
Definition v2_nim_def_struct.hpp:407
Definition v2_nim_def_struct.hpp:2070
bool transient
元素是否瞬态的
Definition v2_nim_def_struct.hpp:2076
nstd::optional< nstd::string > elementOwnerAccountId
元素属于的账号
Definition v2_nim_def_struct.hpp:2078
nstd::string elementValue
元素的值
Definition v2_nim_def_struct.hpp:2074
nstd::string elementKey
元素的唯一key
Definition v2_nim_def_struct.hpp:2072
Definition v2_nim_def_struct.hpp:1988
bool persistence
更新信息持久化
Definition v2_nim_def_struct.hpp:2000
nstd::optional< nstd::string > roomNick
聊天室显示的昵称
Definition v2_nim_def_struct.hpp:1990
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:1998
nstd::optional< nstd::string > roomAvatar
聊天室显示的头像
Definition v2_nim_def_struct.hpp:1992
nstd::optional< nstd::string > serverExtension
成员扩展字段
Definition v2_nim_def_struct.hpp:1994
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:1996
Definition v2_nim_def_struct.hpp:1756
nstd::vector< nstd::string > tags
登陆标签
Definition v2_nim_def_struct.hpp:1758
nstd::string notifyTargetTags
登录登出通知标签
Definition v2_nim_def_struct.hpp:1760
Definition v2_nim_def_struct.hpp:2027
nstd::string tag
标签
Definition v2_nim_def_struct.hpp:2029
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:2033
nstd::string pageToken
偏移量
Definition v2_nim_def_struct.hpp:2031
Definition v2_nim_def_struct.hpp:2036
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition v2_nim_def_struct.hpp:2040
V2NIMQueryDirection direction
查询方向
Definition v2_nim_def_struct.hpp:2048
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:2046
uint64_t beginTime
查询起始时间
Definition v2_nim_def_struct.hpp:2042
nstd::vector< nstd::string > tags
查询的标签
Definition v2_nim_def_struct.hpp:2038
uint64_t endTime
查询结束时间
Definition v2_nim_def_struct.hpp:2044
Definition v2_nim_def_struct.hpp:2003
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:2013
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:2011
uint64_t duration
禁言时长, 单位秒
Definition v2_nim_def_struct.hpp:2009
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:2007
nstd::string targetTag
禁言的 tag
Definition v2_nim_def_struct.hpp:2005
Definition v2_nim_def_struct.hpp:199
bool notificationEnabled
是否需要通知
Definition v2_nim_def_struct.hpp:209
nstd::optional< nstd::string > roomName
聊天室名称
Definition v2_nim_def_struct.hpp:201
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition v2_nim_def_struct.hpp:211
nstd::optional< nstd::string > serverExtension
聊天室扩展字段
Definition v2_nim_def_struct.hpp:207
nstd::optional< V2NIMChatroomQueueLevelMode > queueLevelMode
Definition v2_nim_def_struct.hpp:213
nstd::optional< nstd::string > announcement
聊天室公告
Definition v2_nim_def_struct.hpp:203
nstd::optional< nstd::string > liveUrl
聊天室直播地址
Definition v2_nim_def_struct.hpp:205
Definition v2_nim_def_struct.hpp:1013
bool deleteRoam
是否同步删除漫游消息, 默认删除, 该字段只 P2P 时有效
Definition v2_nim_def_struct.hpp:1017
bool onlineSync
是否多端同步, 默认不同步
Definition v2_nim_def_struct.hpp:1019
V2NIMClearHistoryMode clearMode
清理消息方式,默认为 V2NIM_CLEAR_HISTORY_MODE_ALL,表示删除云端和本地
Definition v2_nim_def_struct.hpp:1023
nstd::optional< nstd::string > serverExtension
扩展字段, 多端同步时会同步到其它端
Definition v2_nim_def_struct.hpp:1021
nstd::string conversationId
需要清空消息的对应的会话 ID
Definition v2_nim_def_struct.hpp:1015
Definition v2_nim_def_struct.hpp:1068
uint64_t deleteTime
被删除的时间
Definition v2_nim_def_struct.hpp:1072
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:1070
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition v2_nim_def_struct.hpp:1074
Definition v2_nim_def_struct.hpp:925
V2NIMClientAntispamOperateType operateType
客户端反垃圾文本命中后操作类型
Definition v2_nim_def_struct.hpp:927
nstd::string replacedText
处理后的文本内容
Definition v2_nim_def_struct.hpp:929
Definition v2_nim_def_struct.hpp:2064
std::string config
Definition v2_nim_def_struct.hpp:2066
std::string name
Definition v2_nim_def_struct.hpp:2065
std::vector< V2NIMClientAntispamThesaurusItem > items
Definition v2_nim_def_struct.hpp:2067
Definition v2_nim_def_struct.hpp:2057
std::string config
Definition v2_nim_def_struct.hpp:2061
V2NIMClientAntispamThesaurusMatchType matchType
Definition v2_nim_def_struct.hpp:2059
std::string key
Definition v2_nim_def_struct.hpp:2058
V2NIMClientAntispamOperateType operateType
Definition v2_nim_def_struct.hpp:2060
Definition v2_nim_def_struct.hpp:1077
uint32_t collectionType
收藏索引
Definition v2_nim_def_struct.hpp:1081
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1085
nstd::optional< nstd::string > uniqueId
去重唯一 ID
Definition v2_nim_def_struct.hpp:1087
nstd::string collectionId
收藏信息服务端 ID
Definition v2_nim_def_struct.hpp:1079
nstd::string collectionData
收藏数据
Definition v2_nim_def_struct.hpp:1083
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:1089
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:1091
Definition v2_nim_def_struct.hpp:1120
nstd::vector< V2NIMCollection > collectionList
本次分页查询返回的收藏列表
Definition v2_nim_def_struct.hpp:1124
uint32_t totalCount
总收藏条数
Definition v2_nim_def_struct.hpp:1122
Definition v2_nim_def_struct.hpp:1105
uint64_t endTime
查询结束时间区间, 闭区间, 0 表示当前时间
Definition v2_nim_def_struct.hpp:1109
nstd::optional< V2NIMCollection > anchorCollection
查询锚点
Definition v2_nim_def_struct.hpp:1111
V2NIMQueryDirection direction
查询方向
Definition v2_nim_def_struct.hpp:1113
uint32_t limit
每次查询收藏条数
Definition v2_nim_def_struct.hpp:1115
uint64_t beginTime
查询开始时间区间, 闭区间
Definition v2_nim_def_struct.hpp:1107
uint32_t collectionType
收藏类型
Definition v2_nim_def_struct.hpp:1117
Definition v2_nim_def_struct.hpp:1297
bool ignoreMuted
过滤免打扰会话
Definition v2_nim_def_struct.hpp:1303
nstd::string conversationGroupId
过滤指定分组的会话, nullopt: 不过滤会话分组
Definition v2_nim_def_struct.hpp:1301
nstd::set< V2NIMConversationType > conversationTypes
过滤指定对话类型, empty: 不限制会话类型
Definition v2_nim_def_struct.hpp:1299
Definition v2_nim_def_struct.hpp:1306
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:1316
nstd::string name
会话分组名称
Definition v2_nim_def_struct.hpp:1310
nstd::string groupId
会话分组 ID
Definition v2_nim_def_struct.hpp:1308
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1312
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:1314
Definition v2_nim_def_struct.hpp:1319
nstd::vector< V2NIMConversationOperationResult > failedList
失败的会话列表
Definition v2_nim_def_struct.hpp:1323
V2NIMConversationGroup group
会话分组信息
Definition v2_nim_def_struct.hpp:1321
Definition v2_nim_def_struct.hpp:1236
nstd::optional< nstd::string > localExtension
本地扩展信息
Definition v2_nim_def_struct.hpp:1252
nstd::vector< nstd::string > groupIds
会话分组 ID 列表
Definition v2_nim_def_struct.hpp:1250
V2NIMConversationType type
会话类型
Definition v2_nim_def_struct.hpp:1240
uint64_t updateTime
会话更新时间
Definition v2_nim_def_struct.hpp:1264
nstd::optional< nstd::string > name
会话名称
Definition v2_nim_def_struct.hpp:1242
uint64_t sortOrder
会话排序时间
Definition v2_nim_def_struct.hpp:1260
uint64_t createTime
会话创建时间
Definition v2_nim_def_struct.hpp:1262
nstd::optional< V2NIMLastMessage > lastMessage
最后一条消息
Definition v2_nim_def_struct.hpp:1256
nstd::optional< nstd::string > serverExtension
服务端扩展信息
Definition v2_nim_def_struct.hpp:1254
nstd::string conversationId
会话标识
Definition v2_nim_def_struct.hpp:1238
uint32_t unreadCount
未读计数
Definition v2_nim_def_struct.hpp:1258
nstd::optional< nstd::string > avatar
会话头像
Definition v2_nim_def_struct.hpp:1244
bool stickTop
置顶
Definition v2_nim_def_struct.hpp:1248
bool mute
免打扰
Definition v2_nim_def_struct.hpp:1246
Definition v2_nim_def_struct.hpp:1276
nstd::string conversationId
会话标识
Definition v2_nim_def_struct.hpp:1278
V2NIMError error
错误
Definition v2_nim_def_struct.hpp:1280
Definition v2_nim_def_struct.hpp:1288
bool onlyUnread
false: 查询所有会话, true: 查询包含未读的会话
Definition v2_nim_def_struct.hpp:1294
nstd::vector< V2NIMConversationType > conversationTypes
查询指定会话类型, empty: 不限制会话类型
Definition v2_nim_def_struct.hpp:1290
nstd::optional< nstd::vector< nstd::string > > conversationGroupIds
查询指定分组的会话, null: 查询所有分组, empty: 查询未分组的会话
Definition v2_nim_def_struct.hpp:1292
Definition v2_nim_def_struct.hpp:1267
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:1271
uint64_t offset
下一次拉取的偏移
Definition v2_nim_def_struct.hpp:1269
nstd::vector< V2NIMConversation > conversationList
会话列表
Definition v2_nim_def_struct.hpp:1273
Definition v2_nim_def_struct.hpp:1283
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1285
Definition v2_nim_def_struct.hpp:1470
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition v2_nim_def_struct.hpp:1494
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:1480
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition v2_nim_def_struct.hpp:1492
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition v2_nim_def_struct.hpp:1486
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:1476
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:1482
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition v2_nim_def_struct.hpp:1490
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition v2_nim_def_struct.hpp:1488
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1474
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:1496
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:1478
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1484
nstd::string name
群组名称
Definition v2_nim_def_struct.hpp:1472
Definition v2_nim_def_struct.hpp:1512
V2NIMTeam team
被创建的群组信息
Definition v2_nim_def_struct.hpp:1514
nstd::vector< nstd::string > failedList
被邀请成员失败列表
Definition v2_nim_def_struct.hpp:1516
Definition v2_nim_def_struct.hpp:753
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:769
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:771
nstd::string receiverId
通知接收者账号
Definition v2_nim_def_struct.hpp:757
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition v2_nim_def_struct.hpp:767
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition v2_nim_def_struct.hpp:765
nstd::string senderId
通知发送者账号
Definition v2_nim_def_struct.hpp:755
uint64_t timestamp
客户设置时间戳
Definition v2_nim_def_struct.hpp:761
nstd::string content
通知内容
Definition v2_nim_def_struct.hpp:763
V2NIMConversationType conversationType
通知所属会话类型
Definition v2_nim_def_struct.hpp:759
自定义用户状态参数
Definition v2_nim_def_struct.hpp:2412
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition v2_nim_def_struct.hpp:2418
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 7 天
Definition v2_nim_def_struct.hpp:2416
uint32_t statusType
自定义设置值 10000 以上,不包括 10000,10000 以内为内部预定义值。小于 10000 将返回参数错误
Definition v2_nim_def_struct.hpp:2414
bool multiSync
用户发布状态时是否需要多端同步
Definition v2_nim_def_struct.hpp:2422
bool onlineOnly
用户发布状态时是否只广播给在线的订阅者
Definition v2_nim_def_struct.hpp:2420
自定义用户状态发布结果
Definition v2_nim_def_struct.hpp:2426
nstd::string serverId
服务器针对该状态事件生成的 ID
Definition v2_nim_def_struct.hpp:2430
time_t publishTime
用户状态发布时的时间
Definition v2_nim_def_struct.hpp:2432
nstd::string uniqueId
发布自定义用户状态时,内部生成的唯一 ID
Definition v2_nim_def_struct.hpp:2428
Definition v2_nim_def_struct.hpp:1200
V2NIMDataSyncType type
数据同步类型
Definition v2_nim_def_struct.hpp:1202
V2NIMDataSyncState state
数据同步状态
Definition v2_nim_def_struct.hpp:1204
Definition v2_nim_def_struct.hpp:83
V2NIMSQLCipherVersion sqlcipherVersion
SQLCipher 版本, 仅 macOS / Linux 平台有效
Definition v2_nim_def_struct.hpp:93
bool enableRestore
是否开启用户数据恢复(本地)功能
Definition v2_nim_def_struct.hpp:89
nstd::string encryptionKey
数据库加密密钥
Definition v2_nim_def_struct.hpp:85
nstd::string backupFolder
用户数据备份(本地)目录, 缺省在数据文件所在目录创建一个dbFile.back目录
Definition v2_nim_def_struct.hpp:91
bool enableBackup
是否开启用户数据备份(本地)功能
Definition v2_nim_def_struct.hpp:87
Definition v2_nim_def_struct.hpp:1732
bool dndOn
免打扰是否开启
Definition v2_nim_def_struct.hpp:1736
uint32_t fromM
如果开启免打扰,开始分钟数 (Integer)
Definition v2_nim_def_struct.hpp:1740
uint32_t toM
如果开启免打扰,截止分钟数 (Integer)
Definition v2_nim_def_struct.hpp:1744
uint32_t toH
如果开启免打扰,截止小时数 (Integer)
Definition v2_nim_def_struct.hpp:1742
uint32_t fromH
如果开启免打扰,开始小时数 (Integer)
Definition v2_nim_def_struct.hpp:1738
bool showDetail
是否显示详情
Definition v2_nim_def_struct.hpp:1734
下载消息附件资源请求参数
Definition v2_nim_def_struct.hpp:2118
nstd::optional< nstd::string > saveAs
附件保存路径,如未指定 SDK 将下载到登录用户缓存目录,如指定该参数则以指定的路径为准
Definition v2_nim_def_struct.hpp:2128
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件信息
Definition v2_nim_def_struct.hpp:2120
nstd::optional< nstd::string > messageClientId
消息客户端 ID,如果指定了该参数将下载完成后的本地附件保存路径更新到消息数据库中,下一次查询时将直接返回对应的路径
Definition v2_nim_def_struct.hpp:2126
V2NIMDownloadAttachmentType type
要下载附件的类型 V2NIMDownloadAttachmentType
Definition v2_nim_def_struct.hpp:2122
nstd::optional< V2NIMSize > thumbSize
如果下载的是缩略图或者视频封面,通过该参数指定缩略图大小或视频封面大小
Definition v2_nim_def_struct.hpp:2124
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:20
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:37
nstd::string customAuthUA
自定义鉴权 User Agent 信息
Definition v2_nim_def_struct.hpp:43
nstd::string customAuthRefer
自定义鉴权 Refer 信息
Definition v2_nim_def_struct.hpp:41
V2NIMFCSAuthType fcsAuthType
融合存储认证类型
Definition v2_nim_def_struct.hpp:39
Definition v2_nim_def_struct.hpp:1641
nstd::optional< nstd::string > postscript
附言
Definition v2_nim_def_struct.hpp:1649
nstd::string applicantAccountId
申请者账号
Definition v2_nim_def_struct.hpp:1643
bool read
是否已读
Definition v2_nim_def_struct.hpp:1655
nstd::string operatorAccountId
操作者账号
Definition v2_nim_def_struct.hpp:1647
uint64_t timestamp
时间
Definition v2_nim_def_struct.hpp:1653
nstd::string recipientAccountId
被申请者账号
Definition v2_nim_def_struct.hpp:1645
V2NIMFriendAddApplicationStatus status
状态
Definition v2_nim_def_struct.hpp:1651
Definition v2_nim_def_struct.hpp:1714
uint64_t offset
分页偏移
Definition v2_nim_def_struct.hpp:1716
nstd::vector< V2NIMFriendAddApplicationStatus > status
查询状态
Definition v2_nim_def_struct.hpp:1720
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1718
Definition v2_nim_def_struct.hpp:1723
nstd::vector< V2NIMFriendAddApplication > infos
查询返回的列表
Definition v2_nim_def_struct.hpp:1725
bool finished
分页结束
Definition v2_nim_def_struct.hpp:1729
uint64_t offset
下一次的偏移量
Definition v2_nim_def_struct.hpp:1727
Definition v2_nim_def_struct.hpp:1634
V2NIMFriendAddMode addMode
添加好友模式
Definition v2_nim_def_struct.hpp:1636
nstd::optional< nstd::string > postscript
添加/申请添加好友的附言
Definition v2_nim_def_struct.hpp:1638
Definition v2_nim_def_struct.hpp:1658
bool deleteAlias
是否删除备注
Definition v2_nim_def_struct.hpp:1660
Definition v2_nim_def_struct.hpp:1613
nstd::optional< uint64_t > createTime
创建时间
Definition v2_nim_def_struct.hpp:1623
nstd::optional< uint32_t > flag
Definition v2_nim_def_struct.hpp:1629
nstd::optional< nstd::string > serverExtension
好友扩展字段
Definition v2_nim_def_struct.hpp:1619
nstd::optional< nstd::string > alias
好友备注
Definition v2_nim_def_struct.hpp:1617
V2NIMUser userProfile
好友对应的用户信息
Definition v2_nim_def_struct.hpp:1627
nstd::string accountId
好友账号
Definition v2_nim_def_struct.hpp:1615
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1625
nstd::optional< nstd::string > customerExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1621
nstd::optional< uint32_t > beflag
Definition v2_nim_def_struct.hpp:1631
Definition v2_nim_def_struct.hpp:1670
bool searchAccountId
是否搜索用户账号
Definition v2_nim_def_struct.hpp:1676
bool searchAlias
是否搜索用户昵称
Definition v2_nim_def_struct.hpp:1674
nstd::string keyword
搜索关键字, 默认搜索好友备注, 可以指定是否同时搜索用户账号
Definition v2_nim_def_struct.hpp:1672
Definition v2_nim_def_struct.hpp:1663
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:1667
nstd::optional< nstd::string > alias
别名
Definition v2_nim_def_struct.hpp:1665
Definition v2_nim_def_struct.hpp:125
V2NIMBasicOption basicOption
基础配置
Definition v2_nim_def_struct.hpp:131
V2NIMFCSOption fcsOption
融合存储配置
Definition v2_nim_def_struct.hpp:137
nstd::optional< V2NIMPrivateServerOption > privateServerOption
私有化配置
Definition v2_nim_def_struct.hpp:139
V2NIMLinkOption linkOption
连接相关配置
Definition v2_nim_def_struct.hpp:133
nstd::string appDataPath
app 数据目录, 为空则使用默认目录
Definition v2_nim_def_struct.hpp:129
V2NIMDatabaseOption databaseOption
数据库配置
Definition v2_nim_def_struct.hpp:135
nstd::string appkey
app key
Definition v2_nim_def_struct.hpp:127
Definition v2_nim_def_struct.hpp:1189
V2NIMKickedOfflineReason reason
原因
Definition v2_nim_def_struct.hpp:1191
V2NIMLoginClientType clientType
客户端类型
Definition v2_nim_def_struct.hpp:1195
uint32_t customClientType
自定义客户端类型
Definition v2_nim_def_struct.hpp:1197
nstd::string reasonDesc
说明
Definition v2_nim_def_struct.hpp:1193
Definition v2_nim_def_struct.hpp:1207
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:1217
nstd::optional< V2NIMMessageRefer > messageRefer
最后一条消息引用
Definition v2_nim_def_struct.hpp:1211
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition v2_nim_def_struct.hpp:1233
nstd::optional< V2NIMMessageRevokeType > revokeType
消息撤回类型
Definition v2_nim_def_struct.hpp:1225
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件
Definition v2_nim_def_struct.hpp:1221
nstd::optional< uint32_t > subType
消息子类型
Definition v2_nim_def_struct.hpp:1215
nstd::optional< V2NIMMessageType > messageType
最后一条消息类型
Definition v2_nim_def_struct.hpp:1213
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:1231
nstd::string text
消息文本内容或撤回附言
Definition v2_nim_def_struct.hpp:1219
nstd::optional< nstd::string > senderId
发送者账号信息
Definition v2_nim_def_struct.hpp:1227
nstd::optional< nstd::string > revokeAccountId
消息撤回者账号
Definition v2_nim_def_struct.hpp:1223
nstd::optional< nstd::string > senderName
如果是正常接收的消息,则显示发送者昵称。如果是被撤回的消息,则显示消息撤回者昵称。显示规则:如果是好友,则返回好友备注,否则如果是群成员,返回群成员昵称,否则返回用户昵称
Definition v2_nim_def_struct.hpp:1229
V2NIMLastMessageState lastMessageState
最后一条消息状态
Definition v2_nim_def_struct.hpp:1209
Definition v2_nim_def_struct.hpp:26
uint64_t protocolTimeout
协议超时, 单位毫秒
Definition v2_nim_def_struct.hpp:30
V2NIMSymmetricEncryptionAlgorithm symmetricEncryptionAlgorithm
对称加密通信加密算法
Definition v2_nim_def_struct.hpp:34
uint64_t linkTimeout
连接超时, 单位毫秒
Definition v2_nim_def_struct.hpp:28
V2NIMAsymmetricEncryptionAlgorithm asymmetricEncryptionAlgorithm
非对称加密"交换密钥"协议加密算法
Definition v2_nim_def_struct.hpp:32
本地会话过滤条件
Definition v2_nim_def_struct.hpp:2616
nstd::vector< V2NIMConversationType > conversationTypes
过滤指定会话类型,留空表示不限制会话类型
Definition v2_nim_def_struct.hpp:2618
bool ignoreMuted
是否过滤免打扰的会话类型,true 表示过滤免打扰的会话,false 表示不过滤
Definition v2_nim_def_struct.hpp:2620
本地会话信息
Definition v2_nim_def_struct.hpp:2557
uint64_t createTime
会话创建时间戳
Definition v2_nim_def_struct.hpp:2592
uint64_t sortOrder
Definition v2_nim_def_struct.hpp:2590
uint32_t unreadCount
会话未读消息计数
Definition v2_nim_def_struct.hpp:2587
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:2559
nstd::optional< nstd::string > localExtension
会话本地扩展字段,不会多端同步
Definition v2_nim_def_struct.hpp:2583
uint64_t updateTime
会话更新时间戳
Definition v2_nim_def_struct.hpp:2594
nstd::optional< nstd::string > avatar
Definition v2_nim_def_struct.hpp:2574
nstd::optional< V2NIMLastMessage > lastMessage
会话所属的最近一条消息
Definition v2_nim_def_struct.hpp:2585
nstd::optional< nstd::string > name
Definition v2_nim_def_struct.hpp:2566
bool stickTop
会话置顶状态
Definition v2_nim_def_struct.hpp:2581
bool mute
Definition v2_nim_def_struct.hpp:2579
V2NIMConversationType type
会话类型
Definition v2_nim_def_struct.hpp:2561
本地会话查询选项
Definition v2_nim_def_struct.hpp:2608
bool onlyUnread
是否仅返回有未读消息的会话,true 表示只返回有未读消息的会话,false 表示返回所有会话
Definition v2_nim_def_struct.hpp:2612
nstd::vector< V2NIMConversationType > conversationTypes
查询指定会话类型,留空表示不限制会话类型
Definition v2_nim_def_struct.hpp:2610
本地会话查询结果
Definition v2_nim_def_struct.hpp:2598
nstd::vector< V2NIMLocalConversation > conversationList
本地会话列表
Definition v2_nim_def_struct.hpp:2604
uint32_t offset
下一次偏移量
Definition v2_nim_def_struct.hpp:2600
bool finished
数据是否拉取完毕,true 表示拉取完毕,false 表示还有数据
Definition v2_nim_def_struct.hpp:2602
Definition v2_nim_def_struct.hpp:1763
nstd::optional< double > y
空间坐标 Y
Definition v2_nim_def_struct.hpp:1767
nstd::optional< double > z
空间坐标 Z
Definition v2_nim_def_struct.hpp:1769
nstd::optional< double > x
空间坐标 X
Definition v2_nim_def_struct.hpp:1765
Definition v2_nim_def_struct.hpp:1172
uint64_t timestamp
登录时间
Definition v2_nim_def_struct.hpp:1178
V2NIMLoginClientType type
客户端类型
Definition v2_nim_def_struct.hpp:1174
nstd::string clientId
客户端 ID
Definition v2_nim_def_struct.hpp:1184
uint32_t customClientType
自定义类型
Definition v2_nim_def_struct.hpp:1182
nstd::string customTag
自定义信息
Definition v2_nim_def_struct.hpp:1180
nstd::string clientIP
客户端外网 IP 地址
Definition v2_nim_def_struct.hpp:1186
nstd::string os
操作系统
Definition v2_nim_def_struct.hpp:1176
Definition v2_nim_def_struct.hpp:1155
uint32_t retryCount
重试次数
Definition v2_nim_def_struct.hpp:1157
V2NIMLoginExtensionProvider loginExtensionProvider
登陆扩展信息获取回调
Definition v2_nim_def_struct.hpp:1167
bool forceMode
强制登录模式
Definition v2_nim_def_struct.hpp:1161
V2NIMDataSyncLevel syncLevel
数据同步等级
Definition v2_nim_def_struct.hpp:1169
V2NIMLoginAuthType authType
认证类型
Definition v2_nim_def_struct.hpp:1163
uint64_t timeout
登录超时, 单位毫秒
Definition v2_nim_def_struct.hpp:1159
V2NIMTokenProvider tokenProvider
动态 token 获取回调
Definition v2_nim_def_struct.hpp:1165
Definition v2_nim_def_struct.hpp:629
V2NIMMessageAIStatus aiStatus
缺省表示普通消息
Definition v2_nim_def_struct.hpp:633
nstd::string accountId
数字人账号信息
Definition v2_nim_def_struct.hpp:631
Definition v2_nim_def_struct.hpp:636
nstd::string accountId
数字人账号信息
Definition v2_nim_def_struct.hpp:638
nstd::optional< V2NIMAIModelCallContent > content
请求大模型的内容
Definition v2_nim_def_struct.hpp:640
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition v2_nim_def_struct.hpp:644
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:642
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空, 则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:646
Definition v2_nim_def_struct.hpp:821
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition v2_nim_def_struct.hpp:829
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:831
V2NIMAIModelCallContent aiModelCallParams
请求大模型的内容
Definition v2_nim_def_struct.hpp:825
nstd::optional< nstd::vector< V2NIMMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:827
nstd::string accountId
AI 代理人的账号
Definition v2_nim_def_struct.hpp:823
Definition v2_nim_def_struct.hpp:475
nstd::optional< nstd::string > antispamExtension
易盾反垃圾(增强检测数据), json格式, 限制长度 1024 字节
Definition v2_nim_def_struct.hpp:487
bool antispamEnabled
指定是否需要过安全通
Definition v2_nim_def_struct.hpp:477
nstd::optional< nstd::string > antispamCustomMessage
Definition v2_nim_def_struct.hpp:483
nstd::optional< nstd::string > antispamCheating
易盾反作弊(辅助检测数据), json格式, 限制长度 1024 字节
Definition v2_nim_def_struct.hpp:485
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id, 而不使用云信后台配置的
Definition v2_nim_def_struct.hpp:479
Definition v2_nim_def_struct.hpp:272
nstd::string raw
附件内容
Definition v2_nim_def_struct.hpp:274
V2NIMMessageAttachmentType attachmentType
Definition v2_nim_def_struct.hpp:276
virtual ~V2NIMMessageAttachment()=default
Definition v2_nim_def_struct.hpp:311
uint32_t duration
语音文件播放时长
Definition v2_nim_def_struct.hpp:314
V2NIMMessageAudioAttachment()
Definition v2_nim_def_struct.hpp:312
Definition v2_nim_def_struct.hpp:340
int32_t status
通话状态,业务自定义状态
Definition v2_nim_def_struct.hpp:347
nstd::string channelId
话单频道 ID
Definition v2_nim_def_struct.hpp:345
V2NIMMessageCallAttachment()
Definition v2_nim_def_struct.hpp:341
nstd::vector< V2NIMMessageCallDuration > durations
通话成员时长列表
Definition v2_nim_def_struct.hpp:349
int32_t type
话单类型, 业务自定义
Definition v2_nim_def_struct.hpp:343
话单消息通话时长描述信息
Definition v2_nim_def_struct.hpp:250
uint32_t duration
通话时长, 单位秒
Definition v2_nim_def_struct.hpp:254
nstd::string accountId
话单对应成员的账号 ID
Definition v2_nim_def_struct.hpp:252
Definition v2_nim_def_struct.hpp:983
nstd::string replaceContent
处理后的文本内容
Definition v2_nim_def_struct.hpp:987
V2NIMMessageClientAntispamOperatorType operateType
客户端反垃圾文本命中后操作类型
Definition v2_nim_def_struct.hpp:985
Definition v2_nim_def_struct.hpp:524
bool readReceiptEnabled
是否需要消息已读回执信息
Definition v2_nim_def_struct.hpp:526
bool lastMessageUpdateEnabled
是否需要更新消息所属的会话信息
Definition v2_nim_def_struct.hpp:528
bool historyEnabled
是否需要存历史消息
Definition v2_nim_def_struct.hpp:530
bool onlineSyncEnabled
是否需要发送方多端在线同步消息
Definition v2_nim_def_struct.hpp:534
bool unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:538
bool offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:536
bool roamingEnabled
是否需要存漫游消息
Definition v2_nim_def_struct.hpp:532
自定义消息附件
Definition v2_nim_def_struct.hpp:2466
virtual void parse(const nstd::string &attach)=0
V2NIMMessageCustomAttachment()
Definition v2_nim_def_struct.hpp:2467
自定义消息附件解析器
Definition v2_nim_def_struct.hpp:2472
virtual ~V2NIMMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition v2_nim_def_struct.hpp:1059
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition v2_nim_def_struct.hpp:1065
uint64_t deleteTime
被删除的时间
Definition v2_nim_def_struct.hpp:1063
V2NIMMessageRefer messageRefer
被删除的消息引用
Definition v2_nim_def_struct.hpp:1061
Definition v2_nim_def_struct.hpp:281
nstd::string path
文件本地路径
Definition v2_nim_def_struct.hpp:292
nstd::string ext
文件扩展名
Definition v2_nim_def_struct.hpp:294
nstd::string name
文件显示名称
Definition v2_nim_def_struct.hpp:290
V2NIMMessageFileAttachment()
Definition v2_nim_def_struct.hpp:282
nstd::string url
文件 url
Definition v2_nim_def_struct.hpp:288
V2NIMMessageAttachmentUploadState uploadState
附件上传状态
Definition v2_nim_def_struct.hpp:298
nstd::string sceneName
文件存储场景
Definition v2_nim_def_struct.hpp:296
nstd::string md5
文件 md5
Definition v2_nim_def_struct.hpp:286
uint64_t size
文件大小
Definition v2_nim_def_struct.hpp:284
Definition v2_nim_def_struct.hpp:649
bool isSelf
消息发送者是否是自己
Definition v2_nim_def_struct.hpp:701
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:689
nstd::optional< nstd::string > localExtension
本地扩展
Definition v2_nim_def_struct.hpp:677
uint64_t createTime
消息时间
Definition v2_nim_def_struct.hpp:655
nstd::string conversationId
消息所属会话 ID
Definition v2_nim_def_struct.hpp:665
nstd::optional< uint64_t > modifyTime
消息更新时间
Definition v2_nim_def_struct.hpp:705
nstd::optional< V2NIMMessageRefer > threadReply
回复消息引用
Definition v2_nim_def_struct.hpp:699
V2NIMMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:687
nstd::string receiverId
消息接收者账号
Definition v2_nim_def_struct.hpp:661
V2NIMConversationType conversationType
消息所属会话类型
Definition v2_nim_def_struct.hpp:663
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:693
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition v2_nim_def_struct.hpp:675
nstd::optional< V2NIMMessageAIConfig > aiConfig
AI 数字人相关信息
Definition v2_nim_def_struct.hpp:703
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:691
nstd::string senderId
消息发送者账号
Definition v2_nim_def_struct.hpp:657
nstd::optional< nstd::string > callbackExtension
回调扩展
Definition v2_nim_def_struct.hpp:679
nstd::string senderName
消息发送者发送该消息时那一刻的昵称
Definition v2_nim_def_struct.hpp:659
nstd::optional< V2NIMMessageRefer > threadRoot
Thread 消息引用
Definition v2_nim_def_struct.hpp:697
uint32_t subType
消息内容
Definition v2_nim_def_struct.hpp:669
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:673
nstd::string messageServerId
服务端消息 ID
Definition v2_nim_def_struct.hpp:653
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition v2_nim_def_struct.hpp:695
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition v2_nim_def_struct.hpp:681
V2NIMMessageStatus messageStatus
消息状态
Definition v2_nim_def_struct.hpp:685
nstd::optional< nstd::string > modifyAccountId
消息更新者账号
Definition v2_nim_def_struct.hpp:707
V2NIMMessageType messageType
消息类型
Definition v2_nim_def_struct.hpp:667
nstd::string messageClientId
客户端消息 ID
Definition v2_nim_def_struct.hpp:651
nstd::string text
消息文本
Definition v2_nim_def_struct.hpp:671
nstd::optional< V2NIMMessageAttachmentUploadState > attachmentUploadState
附件上传状态
Definition v2_nim_def_struct.hpp:683
Definition v2_nim_def_struct.hpp:302
uint32_t width
图片宽度
Definition v2_nim_def_struct.hpp:305
uint32_t height
图片高度
Definition v2_nim_def_struct.hpp:307
V2NIMMessageImageAttachment()
Definition v2_nim_def_struct.hpp:303
Definition v2_nim_def_struct.hpp:990
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1006
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:994
uint64_t endTime
消息查询结束时间, 闭区间
Definition v2_nim_def_struct.hpp:998
uint32_t limit
查询条数
Definition v2_nim_def_struct.hpp:1000
bool reverse
是否反向排序
Definition v2_nim_def_struct.hpp:1004
nstd::optional< V2NIMMessage > anchorMessage
锚点消息, 根据锚点消息查询, 不包含该消息
Definition v2_nim_def_struct.hpp:1002
bool onlyQueryLocal
是否只查询本地消息
Definition v2_nim_def_struct.hpp:1010
nstd::vector< V2NIMMessageType > messageTypes
根据消息类型查询会话, 为空表示查询所有消息类型
Definition v2_nim_def_struct.hpp:992
uint64_t beginTime
消息查询开始时间, 闭区间
Definition v2_nim_def_struct.hpp:996
bool strictMode
严格模式, 无法确定消息完整性则返回错误
Definition v2_nim_def_struct.hpp:1008
Definition v2_nim_def_struct.hpp:329
nstd::string address
详细位置信息
Definition v2_nim_def_struct.hpp:336
double longitude
经度
Definition v2_nim_def_struct.hpp:334
double latitude
纬度
Definition v2_nim_def_struct.hpp:332
V2NIMMessageLocationAttachment()
Definition v2_nim_def_struct.hpp:330
Definition v2_nim_def_struct.hpp:894
V2NIMMessageRefer messageRefer
pin 消息引用
Definition v2_nim_def_struct.hpp:896
uint64_t updateTime
更新时间
Definition v2_nim_def_struct.hpp:904
nstd::string operatorId
操作者 ID
Definition v2_nim_def_struct.hpp:898
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:900
uint64_t createTime
创建时间
Definition v2_nim_def_struct.hpp:902
Definition v2_nim_def_struct.hpp:907
V2NIMMessagePin pin
消息相关的PIN信息
Definition v2_nim_def_struct.hpp:911
V2NIMMessagePinState pinState
消息 PIN 状态
Definition v2_nim_def_struct.hpp:909
Definition v2_nim_def_struct.hpp:441
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition v2_nim_def_struct.hpp:445
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition v2_nim_def_struct.hpp:455
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition v2_nim_def_struct.hpp:451
nstd::string pushPayload
推送数据
Definition v2_nim_def_struct.hpp:449
nstd::string pushContent
推送文本
Definition v2_nim_def_struct.hpp:447
bool pushEnabled
是否需要推送消息
Definition v2_nim_def_struct.hpp:443
nstd::string forcePushContent
强制推送文案
Definition v2_nim_def_struct.hpp:453
Definition v2_nim_def_struct.hpp:582
uint64_t begin
起始时间
Definition v2_nim_def_struct.hpp:584
bool includeEnd
包含结束时间
Definition v2_nim_def_struct.hpp:590
uint64_t end
结束时间
Definition v2_nim_def_struct.hpp:586
bool includeBegin
包含起始时间
Definition v2_nim_def_struct.hpp:588
Definition v2_nim_def_struct.hpp:550
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:562
nstd::string receiverId
接收方账号
Definition v2_nim_def_struct.hpp:554
nstd::string senderId
发送方账号
Definition v2_nim_def_struct.hpp:552
nstd::string messageServerId
服务端消息 id
Definition v2_nim_def_struct.hpp:558
uint64_t createTime
消息时间
Definition v2_nim_def_struct.hpp:564
V2NIMConversationType conversationType
会话类型
Definition v2_nim_def_struct.hpp:560
nstd::string messageClientId
客户端消息 id
Definition v2_nim_def_struct.hpp:556
Definition v2_nim_def_struct.hpp:879
V2NIMMessageRefer messageRefer
被撤回的消息引用
Definition v2_nim_def_struct.hpp:881
nstd::string revokeAccountId
消息撤回者账号
Definition v2_nim_def_struct.hpp:887
nstd::optional< nstd::string > postscript
附言
Definition v2_nim_def_struct.hpp:885
nstd::optional< nstd::string > callbackExtension
第三方回调传入的自定义扩展字段
Definition v2_nim_def_struct.hpp:891
V2NIMMessageRevokeType revokeType
消息撤回类型
Definition v2_nim_def_struct.hpp:889
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:883
Definition v2_nim_def_struct.hpp:866
nstd::optional< nstd::string > env
路由抄送地址
Definition v2_nim_def_struct.hpp:876
nstd::optional< nstd::string > pushPayload
推送数据
Definition v2_nim_def_struct.hpp:874
nstd::optional< nstd::string > serverExtension
扩展信息
Definition v2_nim_def_struct.hpp:870
nstd::optional< nstd::string > pushContent
推送文案
Definition v2_nim_def_struct.hpp:872
nstd::optional< nstd::string > postscript
附言
Definition v2_nim_def_struct.hpp:868
Definition v2_nim_def_struct.hpp:499
nstd::optional< nstd::string > function
机器人具体功能, 用户可以自定义输入
Definition v2_nim_def_struct.hpp:505
nstd::optional< nstd::string > customContent
机器人自定义内容
Definition v2_nim_def_struct.hpp:507
nstd::optional< nstd::string > accountId
机器人账号, 仅群聊有效
Definition v2_nim_def_struct.hpp:501
nstd::optional< nstd::string > topic
机器人消息话题
Definition v2_nim_def_struct.hpp:503
Definition v2_nim_def_struct.hpp:510
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition v2_nim_def_struct.hpp:514
bool routeEnabled
是否需要路由消息
Definition v2_nim_def_struct.hpp:512
消息检索参数
Definition v2_nim_def_struct.hpp:2510
nstd::optional< nstd::string > conversationId
要查询的会话 ID,不指定则查询所有会话
Definition v2_nim_def_struct.hpp:2512
int64_t searchTimePeriod
从起始时间点开始的过去时间范围,默认为 0(不限制时间范围)。24 x 60 x 60 x 1000 代表过去一天,单位:毫秒
Definition v2_nim_def_struct.hpp:2524
nstd::optional< nstd::vector< nstd::string > > senderAccountIds
匹配消息发送者,最多支持 5 个,为空则匹配所有发送者
Definition v2_nim_def_struct.hpp:2518
V2NIMSearchKeywordMathType keywordMatchType
指定关键字列表匹配类型,见 V2NIMSearchKeywordMathType,默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition v2_nim_def_struct.hpp:2516
uint32_t limit
搜索的数量限制,默认为 20,最大为 100
Definition v2_nim_def_struct.hpp:2526
nstd::optional< nstd::string > pageToken
下一页的 token,用于分页查询
Definition v2_nim_def_struct.hpp:2528
nstd::optional< nstd::vector< nstd::string > > keywordList
要查询的关键字列表,为空则按发送者或消息类型查询,最多支持 5 个。当消息发送者以及消息类型均未指定时,必须设置关键字列表
Definition v2_nim_def_struct.hpp:2514
time_t searchStartTime
搜索的起始时间点,默认为 0(从现在开始搜索)。UTC 时间戳,单位:毫秒
Definition v2_nim_def_struct.hpp:2522
nstd::optional< nstd::vector< V2NIMMessageType > > messageTypes
匹配消息类型,为空则匹配所有类型
Definition v2_nim_def_struct.hpp:2520
查询消息返回的结果项
Definition v2_nim_def_struct.hpp:2532
uint32_t count
单个会话命中的数量
Definition v2_nim_def_struct.hpp:2538
nstd::vector< V2NIMMessage > messages
返回的消息列表
Definition v2_nim_def_struct.hpp:2536
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:2534
Definition v2_nim_def_struct.hpp:1326
nstd::vector< V2NIMMessageType > messageTypes
要检索的消息类型, 为空表示查询所有消息类型
Definition v2_nim_def_struct.hpp:1346
nstd::vector< nstd::string > teamIds
高级群账号列表
Definition v2_nim_def_struct.hpp:1342
nstd::vector< nstd::string > p2pAccountIds
P2P 账号列表
Definition v2_nim_def_struct.hpp:1340
nstd::vector< nstd::string > senderAccountIds
发送账号列表
Definition v2_nim_def_struct.hpp:1344
uint64_t beginTime
查询起始时间
Definition v2_nim_def_struct.hpp:1330
uint32_t messageLimit
返回消息数量
Definition v2_nim_def_struct.hpp:1336
nstd::vector< uint32_t > messageSubTypes
要检索的消息子类型, 为空表示查询所有消息子类型
Definition v2_nim_def_struct.hpp:1348
V2NIMSortOrder sortOrder
消息排序规则
Definition v2_nim_def_struct.hpp:1338
nstd::string keyword
关键字
Definition v2_nim_def_struct.hpp:1328
uint32_t conversationLimit
检索会话数量
Definition v2_nim_def_struct.hpp:1334
uint64_t endTime
查询结束时间, 0 表示当前时间
Definition v2_nim_def_struct.hpp:1332
查询消息返回的结果
Definition v2_nim_def_struct.hpp:2542
nstd::vector< V2NIMMessageSearchItem > items
Definition v2_nim_def_struct.hpp:2551
nstd::string nextPageToken
下次请求的 token,两次查询参数必须一致
Definition v2_nim_def_struct.hpp:2553
uint32_t count
满足检索条件的所有消息数量
Definition v2_nim_def_struct.hpp:2544
Definition v2_nim_def_struct.hpp:593
V2NIMErrorCode errorCode
消息发送失败后的错误码信息
Definition v2_nim_def_struct.hpp:595
bool readReceiptSent
Definition v2_nim_def_struct.hpp:598
群组定向消息数据结构
Definition v2_nim_def_struct.hpp:836
nstd::vector< nstd::string > receiverIds
接收者 ID 列表
Definition v2_nim_def_struct.hpp:840
bool inclusive
为 true 时表示消息发送到群组中 receiverIds 对应的成员,为 false 时表示消息发送到群组中排除 receiverIds 以外的所有成员
Definition v2_nim_def_struct.hpp:838
bool newMemberVisible
新成员是否可以查看该定向消息
Definition v2_nim_def_struct.hpp:842
Definition v2_nim_def_struct.hpp:353
V2NIMMessageNotificationType type
通知类型
Definition v2_nim_def_struct.hpp:356
nstd::vector< nstd::string > targetIds
被操作者 ID 列表
Definition v2_nim_def_struct.hpp:360
nstd::optional< nstd::string > serverExtension
扩展字段
Definition v2_nim_def_struct.hpp:358
bool chatBanned
群成员是否被禁言
Definition v2_nim_def_struct.hpp:362
V2NIMMessageTeamNotificationAttachment()
Definition v2_nim_def_struct.hpp:354
nstd::optional< V2NIMUpdatedTeamInfo > updatedTeamInfo
群信息更新字段,有相应字段信息,则表示对应字段被修改
Definition v2_nim_def_struct.hpp:364
Definition v2_nim_def_struct.hpp:318
uint32_t height
图片高度
Definition v2_nim_def_struct.hpp:325
V2NIMMessageVideoAttachment()
Definition v2_nim_def_struct.hpp:319
uint32_t width
图片宽度
Definition v2_nim_def_struct.hpp:323
uint32_t duration
视频文件播放时长
Definition v2_nim_def_struct.hpp:321
Definition v2_nim_def_struct.hpp:721
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition v2_nim_def_struct.hpp:727
nstd::optional< V2NIMMessageRouteConfig > routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:733
nstd::optional< uint32_t > subType
消息子类型
Definition v2_nim_def_struct.hpp:723
nstd::optional< V2NIMMessageAntispamConfig > antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:731
nstd::optional< nstd::string > text
消息内容
Definition v2_nim_def_struct.hpp:725
nstd::optional< nstd::string > serverExtension
消息服务端扩展
Definition v2_nim_def_struct.hpp:729
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:737
nstd::optional< V2NIMMessagePushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:735
nstd::optional< nstd::string > clientAntispamReplace
反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:739
Definition v2_nim_def_struct.hpp:941
nstd::string antispamResult
云端反垃圾返回的结果
Definition v2_nim_def_struct.hpp:947
V2NIMMessage message
修改成功后的消息体
Definition v2_nim_def_struct.hpp:943
V2NIMClientAntispamResult clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:949
int32_t errorCode
返回错误码
Definition v2_nim_def_struct.hpp:945
Definition v2_nim_def_struct.hpp:490
nstd::optional< nstd::string > antispamCustomMessage
Definition v2_nim_def_struct.hpp:496
bool antispamEnabled
指定是否需要过安全通
Definition v2_nim_def_struct.hpp:492
Definition v2_nim_def_struct.hpp:541
nstd::optional< nstd::string > clientNotificationId
外部输入标识字段,建议输入时每次串唯一,长度不超过 32 个字符
Definition v2_nim_def_struct.hpp:547
bool offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:543
bool unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:545
Definition v2_nim_def_struct.hpp:458
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition v2_nim_def_struct.hpp:462
nstd::string forcePushContent
强制推送文案
Definition v2_nim_def_struct.hpp:470
bool pushEnabled
是否需要推送通知
Definition v2_nim_def_struct.hpp:460
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition v2_nim_def_struct.hpp:468
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition v2_nim_def_struct.hpp:472
nstd::string pushPayload
推送数据
Definition v2_nim_def_struct.hpp:466
nstd::string pushContent
推送文本
Definition v2_nim_def_struct.hpp:464
Definition v2_nim_def_struct.hpp:517
bool routeEnabled
是否需要路由通知
Definition v2_nim_def_struct.hpp:519
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition v2_nim_def_struct.hpp:521
Definition v2_nim_def_struct.hpp:976
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:978
uint64_t timestamp
最后一条已读消息时间, 比该时间早的消息都可以认为已读
Definition v2_nim_def_struct.hpp:980
Definition v2_nim_def_struct.hpp:46
nstd::string defaultQUICLinkAddress
默认 QUIC link 地址
Definition v2_nim_def_struct.hpp:56
nstd::string defaultNosUploadAddress
默认 nos 上传地址
Definition v2_nim_def_struct.hpp:62
nstd::string defaultNosUploadHost
默认 nos 上传主机地址
Definition v2_nim_def_struct.hpp:64
nstd::string probeIpv4Url
探测 ipv4 地址类型使用的 url
Definition v2_nim_def_struct.hpp:72
nstd::string nosDownloadAddress
nos 下载地址拼接模板, 用于拼接最终得到的下载地址
Definition v2_nim_def_struct.hpp:66
nstd::string asymmetricEncryptionKeyA
非对称加密密钥 A, RSA: module, SM2: X
Definition v2_nim_def_struct.hpp:76
uint32_t asymmetricEncryptionKeyVersion
非对称加密算法 key 版本号
Definition v2_nim_def_struct.hpp:80
V2NIMIPProtocolVersion ipProtocolVersion
IP 协议版本
Definition v2_nim_def_struct.hpp:48
nstd::string defaultQUICLinkAddressIpv6
默认 ipv6 QUIC link 地址
Definition v2_nim_def_struct.hpp:60
nstd::vector< nstd::string > lbsAddresses
lbs 地址
Definition v2_nim_def_struct.hpp:50
nstd::string defaultLinkAddress
默认 link 地址
Definition v2_nim_def_struct.hpp:54
nstd::vector< nstd::string > nosAccelerateHosts
nos 加速域名列表
Definition v2_nim_def_struct.hpp:68
nstd::string nosLbsAddress
nos lbs 地址
Definition v2_nim_def_struct.hpp:52
nstd::string asymmetricEncryptionKeyB
非对称加密密钥 B, RSA: EXP, SM2: SM2Y
Definition v2_nim_def_struct.hpp:78
nstd::string probeIpv6Url
探测 ipv6 地址类型使用的 url
Definition v2_nim_def_struct.hpp:74
nstd::string nosAccelerateAddress
nos 加速地址拼接模板, 用于获得加速后的下载地址
Definition v2_nim_def_struct.hpp:70
nstd::string defaultLinkAddressIpv6
默认 ipv6 link 地址
Definition v2_nim_def_struct.hpp:58
Definition v2_nim_def_struct.hpp:796
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id
Definition v2_nim_def_struct.hpp:800
nstd::optional< bool > antispamEnabled
指定消息是否需要经过安全通。默认为 true
Definition v2_nim_def_struct.hpp:798
AI 数字人代理请求参数
Definition v2_nim_def_struct.hpp:804
nstd::string requestId
请求 ID
Definition v2_nim_def_struct.hpp:808
nstd::string accountId
机器人账号 ID
Definition v2_nim_def_struct.hpp:806
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换, 如果 V2NIMAIUser 中的 modelConfig.prompt 定义了变量,则必填. 端测不校验
Definition v2_nim_def_struct.hpp:814
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition v2_nim_def_struct.hpp:812
V2NIMAIModelCallContent content
请求大模型的内容
Definition v2_nim_def_struct.hpp:810
nstd::optional< V2NIMProxyAICallAntispamConfig > antispamConfig
反垃圾配置, 复用消息体里的部分反垃圾字段
Definition v2_nim_def_struct.hpp:818
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition v2_nim_def_struct.hpp:816
代理请求回调
Definition v2_nim_def_struct.hpp:2500
time_t time
发送时间,毫秒
Definition v2_nim_def_struct.hpp:2506
nstd::string fromAccountId
发送方账号
Definition v2_nim_def_struct.hpp:2502
nstd::string body
通知体
Definition v2_nim_def_struct.hpp:2504
HTTP 代理请求参数
Definition v2_nim_def_struct.hpp:2478
nstd::optional< nstd::string > body
请求体
Definition v2_nim_def_struct.hpp:2488
nstd::optional< nstd::string > header
请求头
Definition v2_nim_def_struct.hpp:2486
nstd::optional< nstd::string > zone
映射一个请求地址,不传使用服务器默认的配置
Definition v2_nim_def_struct.hpp:2484
V2NIMProxyRequestMethod method
请求方法
Definition v2_nim_def_struct.hpp:2482
nstd::string path
请求路径
Definition v2_nim_def_struct.hpp:2480
HTTP 代理响应
Definition v2_nim_def_struct.hpp:2492
nstd::string header
响应头
Definition v2_nim_def_struct.hpp:2494
nstd::string body
响应体
Definition v2_nim_def_struct.hpp:2496
Definition v2_nim_def_struct.hpp:1916
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:1922
nstd::string clientAntispamReplace
反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:1926
nstd::vector< nstd::string > receiverIds
定向消息接收者账号列表, 为空表示不定向, 定向消息不存历史
Definition v2_nim_def_struct.hpp:1928
V2NIMChatroomMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:1918
nstd::string notifyTargetTags
消息的目标标签表达式
Definition v2_nim_def_struct.hpp:1930
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition v2_nim_def_struct.hpp:1932
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:1920
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:1924
Definition v2_nim_def_struct.hpp:1935
V2NIMChatroomMessage message
发送成功后的消息体
Definition v2_nim_def_struct.hpp:1937
nstd::string antispamResult
云端反垃圾返回的结果
Definition v2_nim_def_struct.hpp:1939
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:1941
Definition v2_nim_def_struct.hpp:914
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:922
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:920
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition v2_nim_def_struct.hpp:916
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition v2_nim_def_struct.hpp:918
Definition v2_nim_def_struct.hpp:845
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition v2_nim_def_struct.hpp:853
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition v2_nim_def_struct.hpp:855
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition v2_nim_def_struct.hpp:849
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:851
nstd::string clientAntispamReplace
本地反垃圾命中后替换的文本
Definition v2_nim_def_struct.hpp:859
bool clientAntispamEnabled
是否启用本地反垃圾
Definition v2_nim_def_struct.hpp:857
nstd::optional< V2NIMMessageAIConfigParams > aiConfig
请求大模型的相关参数
Definition v2_nim_def_struct.hpp:861
nstd::optional< V2NIMMessageTargetConfig > targetConfig
用以控制在发送群组消息时,消息是否发送给指定的群组成员
Definition v2_nim_def_struct.hpp:863
V2NIMMessageConfig messageConfig
消息相关配置
Definition v2_nim_def_struct.hpp:847
Definition v2_nim_def_struct.hpp:932
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition v2_nim_def_struct.hpp:938
V2NIMMessage message
发送成功后的消息体
Definition v2_nim_def_struct.hpp:934
nstd::optional< nstd::string > antispamResult
反垃圾返回的结果
Definition v2_nim_def_struct.hpp:936
拒绝别人邀请加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2344
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2346
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2350
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2352
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2354
nstd::string inviterAccountId
邀请者账号 ID
Definition v2_nim_def_struct.hpp:2348
信令呼叫参数
Definition v2_nim_def_struct.hpp:2170
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2184
nstd::optional< nstd::string > channelName
频道名称,建议使用与业务有相关场景的名称,便于页面显示
Definition v2_nim_def_struct.hpp:2178
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,跟频道绑定,JSON 格式
Definition v2_nim_def_struct.hpp:2180
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:2186
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2188
nstd::string calleeAccountId
被呼叫者账号 ID
Definition v2_nim_def_struct.hpp:2172
V2NIMSignallingChannelType channelType
频道类型
Definition v2_nim_def_struct.hpp:2176
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2182
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2174
呼叫回包
Definition v2_nim_def_struct.hpp:2252
int32_t callStatus
呼叫状态
Definition v2_nim_def_struct.hpp:2258
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2254
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2256
呼叫建立请求参数,包括接收方进入频道房间相关信息,以及接受方需要的相关音视频房间信息
Definition v2_nim_def_struct.hpp:2262
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2268
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2272
nstd::string callerAccountId
接受的呼叫者账号 ID
Definition v2_nim_def_struct.hpp:2266
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2270
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2264
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2274
接受呼叫请求回包
Definition v2_nim_def_struct.hpp:2278
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2282
nstd::optional< uint32_t > callStatus
呼叫状态
Definition v2_nim_def_struct.hpp:2284
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2280
取消之前的邀请成员加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2316
nstd::string inviteeAccountId
被邀请者账号 ID
Definition v2_nim_def_struct.hpp:2320
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2326
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2324
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2318
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2322
信令频道信息
Definition v2_nim_def_struct.hpp:2192
bool channelValid
频道是否有效
Definition v2_nim_def_struct.hpp:2208
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2200
time_t createTime
频道房间创建时间
Definition v2_nim_def_struct.hpp:2202
nstd::optional< nstd::string > channelName
信令频道名称,如果请求时不传,则该字段为空
Definition v2_nim_def_struct.hpp:2198
nstd::string creatorAccountId
创建者账号 ID
Definition v2_nim_def_struct.hpp:2206
nstd::string channelId
信令频道 ID,唯一标识了该频道房间,后续主要以该字段作为请求标识
Definition v2_nim_def_struct.hpp:2194
V2NIMSignallingChannelType channelType
频道类型
Definition v2_nim_def_struct.hpp:2196
time_t expireTime
频道房间过期时间
Definition v2_nim_def_struct.hpp:2204
Definition v2_nim_def_struct.hpp:2138
nstd::optional< bool > unreadEnabled
是否需要计未读
Definition v2_nim_def_struct.hpp:2142
nstd::optional< bool > offlineEnabled
是否需要存离线消息
Definition v2_nim_def_struct.hpp:2140
nstd::optional< int64_t > selfUid
用户 UID
Definition v2_nim_def_struct.hpp:2144
信令事件
Definition v2_nim_def_struct.hpp:2358
nstd::string operatorAccountId
操作者 ID
Definition v2_nim_def_struct.hpp:2364
nstd::optional< nstd::string > inviteeAccountId
Definition v2_nim_def_struct.hpp:2372
nstd::string requestId
Definition v2_nim_def_struct.hpp:2382
nstd::optional< V2NIMSignallingMember > member
Definition v2_nim_def_struct.hpp:2392
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2366
nstd::optional< V2NIMSignallingPushConfig > pushConfig
Definition v2_nim_def_struct.hpp:2385
nstd::optional< bool > unreadEnabled
Definition v2_nim_def_struct.hpp:2389
nstd::optional< nstd::string > inviterAccountId
Definition v2_nim_def_struct.hpp:2376
V2NIMSignallingChannelInfo channelInfo
信令频道房间相关信息
Definition v2_nim_def_struct.hpp:2362
uint64_t time
操作的时间点
Definition v2_nim_def_struct.hpp:2368
V2NIMSignallingEventType eventType
信令频道事件类型
Definition v2_nim_def_struct.hpp:2360
邀请成员加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2300
nstd::string inviteeAccountId
被邀请者账号 ID
Definition v2_nim_def_struct.hpp:2304
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition v2_nim_def_struct.hpp:2312
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2310
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition v2_nim_def_struct.hpp:2308
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2306
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2302
加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2288
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2290
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition v2_nim_def_struct.hpp:2294
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition v2_nim_def_struct.hpp:2296
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2292
加入信令房间结果
Definition v2_nim_def_struct.hpp:2244
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition v2_nim_def_struct.hpp:2248
V2NIMSignallingRoomInfo roomInfo
信令房间相关信息
Definition v2_nim_def_struct.hpp:2246
信令房间用户信息
Definition v2_nim_def_struct.hpp:2212
time_t joinTime
用户加入信令频道房间时间
Definition v2_nim_def_struct.hpp:2218
int64_t uid
成员 UID
Definition v2_nim_def_struct.hpp:2216
time_t expireTime
用户信令频道房间过期时间
Definition v2_nim_def_struct.hpp:2220
nstd::string deviceId
成员操作的设备 ID
Definition v2_nim_def_struct.hpp:2222
nstd::string accountId
成员账号 ID
Definition v2_nim_def_struct.hpp:2214
消息推送相关配置
Definition v2_nim_def_struct.hpp:2148
nstd::optional< nstd::string > pushTitle
推送标题
Definition v2_nim_def_struct.hpp:2152
nstd::optional< nstd::string > pushContent
推送文案
Definition v2_nim_def_struct.hpp:2154
nstd::optional< nstd::string > pushPayload
推送数据
Definition v2_nim_def_struct.hpp:2156
bool pushEnabled
是否需要推送
Definition v2_nim_def_struct.hpp:2150
拒绝别人邀请加入信令房间请求参数
Definition v2_nim_def_struct.hpp:2330
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition v2_nim_def_struct.hpp:2332
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition v2_nim_def_struct.hpp:2338
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition v2_nim_def_struct.hpp:2340
nstd::string inviterAccountId
邀请者账号 ID
Definition v2_nim_def_struct.hpp:2334
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition v2_nim_def_struct.hpp:2336
信令房间相关信息
Definition v2_nim_def_struct.hpp:2226
V2NIMSignallingChannelInfo channelInfo
频道房间相关信息
Definition v2_nim_def_struct.hpp:2228
nstd::vector< V2NIMSignallingMember > members
成员列表信息
Definition v2_nim_def_struct.hpp:2230
音视频相关配置
Definition v2_nim_def_struct.hpp:2160
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频 SDK 相关参数,IM 信令仅透传相关参数
Definition v2_nim_def_struct.hpp:2166
nstd::optional< nstd::string > rtcChannelName
云信音视频房间频道名称
Definition v2_nim_def_struct.hpp:2162
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition v2_nim_def_struct.hpp:2164
音视频房间信息
Definition v2_nim_def_struct.hpp:2234
nstd::optional< nstd::string > rtcToken
进入音视频对应的 token
Definition v2_nim_def_struct.hpp:2236
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频SDK相关参数,IM 信令仅透传相关参数
Definition v2_nim_def_struct.hpp:2240
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition v2_nim_def_struct.hpp:2238
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:142
uint64_t expireTime
过期时间, 单位秒, 0 表示不过期
Definition v2_nim_def_struct.hpp:146
nstd::string sceneName
场景名
Definition v2_nim_def_struct.hpp:144
事件订阅选项
Definition v2_nim_def_struct.hpp:2396
nstd::vector< nstd::string > accountIds
订阅的成员列表,为空返回参数错误,单次数量不超过 100,列表数量如果超限,默认截取前 100 个账号
Definition v2_nim_def_struct.hpp:2398
uint32_t duration
订阅的有效期,时间范围为 60~2592000,单位:秒,过期后需要重新订阅。如果未过期的情况下重复订阅,新设置的有效期会覆盖之前的有效期
Definition v2_nim_def_struct.hpp:2400
bool immediateSync
订阅后是否立即同步事件状态值,默认为 false,为 true 表示立即同步当前状态值。但为了性能考虑,30s 内重复订阅会忽略该参数
Definition v2_nim_def_struct.hpp:2402
Definition v2_nim_def_struct.hpp:1366
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition v2_nim_def_struct.hpp:1396
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:1404
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:1384
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition v2_nim_def_struct.hpp:1398
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition v2_nim_def_struct.hpp:1394
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition v2_nim_def_struct.hpp:1402
nstd::string ownerAccountId
群组创建者/拥有者 ID
Definition v2_nim_def_struct.hpp:1374
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:1386
bool isValidTeam
是否为自己所在且有效的群, 群存在且我在群组中
Definition v2_nim_def_struct.hpp:1406
nstd::optional< uint64_t > teamMemberTime
Definition v2_nim_def_struct.hpp:1410
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1370
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1390
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:1388
uint64_t createTime
群组创建时间
Definition v2_nim_def_struct.hpp:1380
nstd::string name
群组名称
Definition v2_nim_def_struct.hpp:1372
uint32_t memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:1376
uint32_t bits
Definition v2_nim_def_struct.hpp:1408
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition v2_nim_def_struct.hpp:1400
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由openApi设置
Definition v2_nim_def_struct.hpp:1392
uint64_t updateTime
群组更新时间
Definition v2_nim_def_struct.hpp:1382
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1368
uint32_t memberCount
群组当前人数
Definition v2_nim_def_struct.hpp:1378
Definition v2_nim_def_struct.hpp:1535
V2NIMTeamJoinActionStatus actionStatus
操作状态
Definition v2_nim_def_struct.hpp:1549
uint64_t timestamp
申请时间
Definition v2_nim_def_struct.hpp:1547
V2NIMTeamJoinActionType actionType
入群操作类型
Definition v2_nim_def_struct.hpp:1537
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1539
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1541
nstd::string operatorAccountId
申请者账号
Definition v2_nim_def_struct.hpp:1543
nstd::optional< nstd::string > postscript
申请入群的附言
Definition v2_nim_def_struct.hpp:1545
Definition v2_nim_def_struct.hpp:1679
uint64_t offset
分页偏移
Definition v2_nim_def_struct.hpp:1683
nstd::vector< V2NIMTeamJoinActionStatus > status
查询状态
Definition v2_nim_def_struct.hpp:1687
nstd::vector< V2NIMTeamJoinActionType > types
查询类型
Definition v2_nim_def_struct.hpp:1681
uint32_t limit
查询数量
Definition v2_nim_def_struct.hpp:1685
Definition v2_nim_def_struct.hpp:1705
uint64_t offset
下一次的偏移量
Definition v2_nim_def_struct.hpp:1709
bool finished
分页结束
Definition v2_nim_def_struct.hpp:1711
nstd::vector< V2NIMTeamJoinActionInfo > infos
查询返回的列表
Definition v2_nim_def_struct.hpp:1707
Definition v2_nim_def_struct.hpp:1413
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition v2_nim_def_struct.hpp:1435
nstd::vector< nstd::string > followAccountIds
特别关注群成员 account ID 列表
Definition v2_nim_def_struct.hpp:1437
nstd::optional< bool > inTeam
是否在群中
Definition v2_nim_def_struct.hpp:1433
nstd::string accountId
群组成员账号
Definition v2_nim_def_struct.hpp:1419
nstd::optional< uint64_t > joinTime
入群时间
Definition v2_nim_def_struct.hpp:1427
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1429
nstd::optional< uint64_t > bits
Definition v2_nim_def_struct.hpp:1439
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1417
nstd::optional< nstd::string > teamNick
群组昵称
Definition v2_nim_def_struct.hpp:1423
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition v2_nim_def_struct.hpp:1431
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition v2_nim_def_struct.hpp:1421
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1425
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1415
Definition v2_nim_def_struct.hpp:1526
nstd::vector< V2NIMTeamMember > memberList
拉取的成员列表
Definition v2_nim_def_struct.hpp:1532
nstd::string nextToken
下一次查询的偏移量
Definition v2_nim_def_struct.hpp:1530
bool finished
数据是否拉取完毕
Definition v2_nim_def_struct.hpp:1528
Definition v2_nim_def_struct.hpp:1499
nstd::optional< V2NIMTeamMemberRoleQueryType > roleQueryType
群成员类型
Definition v2_nim_def_struct.hpp:1501
V2NIMQueryDirection direction
消息查询方向
Definition v2_nim_def_struct.hpp:1505
uint32_t limit
分页拉取数量
Definition v2_nim_def_struct.hpp:1509
bool onlyChatBanned
是否只返回聊天禁言成员列表
Definition v2_nim_def_struct.hpp:1503
nstd::string nextToken
分页偏移, 首次传空, 后续拉取采用上一次返回的 nextToken
Definition v2_nim_def_struct.hpp:1507
Definition v2_nim_def_struct.hpp:1690
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1694
nstd::string nextToken
Definition v2_nim_def_struct.hpp:1698
V2NIMSortOrder order
按照 joinTime 排序,默认时间降序排列
Definition v2_nim_def_struct.hpp:1700
nstd::optional< nstd::string > teamId
群组ID,如果不传则检索所有群,如果需要检索特定的群,则需要同时传入 teamId + teamType
Definition v2_nim_def_struct.hpp:1696
uint32_t limit
查询成员的个数,默认 10
Definition v2_nim_def_struct.hpp:1702
nstd::string keyword
搜索关键词,不为空
Definition v2_nim_def_struct.hpp:1692
Definition v2_nim_def_struct.hpp:1443
nstd::optional< uint64_t > updateTime
更新时间
Definition v2_nim_def_struct.hpp:1461
nstd::optional< bool > inTeam
是否在群中
Definition v2_nim_def_struct.hpp:1465
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition v2_nim_def_struct.hpp:1463
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:1457
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition v2_nim_def_struct.hpp:1467
nstd::optional< nstd::string > teamNick
群组昵称
Definition v2_nim_def_struct.hpp:1453
nstd::optional< uint64_t > joinTime
入群时间
Definition v2_nim_def_struct.hpp:1459
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition v2_nim_def_struct.hpp:1451
nstd::string accountId
群组成员账号
Definition v2_nim_def_struct.hpp:1449
nstd::string teamId
群组ID
Definition v2_nim_def_struct.hpp:1445
V2NIMTeamType teamType
群组类型
Definition v2_nim_def_struct.hpp:1447
nstd::optional< uint64_t > bits
内部使用字段
Definition v2_nim_def_struct.hpp:1455
Definition v2_nim_def_struct.hpp:967
nstd::vector< nstd::string > readAccountList
已读账号列表
Definition v2_nim_def_struct.hpp:971
V2NIMTeamMessageReadReceipt readReceipt
群消息已读回执
Definition v2_nim_def_struct.hpp:969
nstd::vector< nstd::string > unreadAccountList
未读账号列表
Definition v2_nim_def_struct.hpp:973
Definition v2_nim_def_struct.hpp:952
nstd::optional< nstd::string > latestReadAccount
群消息最新已读账号
Definition v2_nim_def_struct.hpp:964
uint32_t readCount
群消息已读人数
Definition v2_nim_def_struct.hpp:960
nstd::string messageClientId
消息客户端 ID
Definition v2_nim_def_struct.hpp:958
nstd::string conversationId
会话 ID
Definition v2_nim_def_struct.hpp:954
uint32_t unreadCount
群消息未读人数
Definition v2_nim_def_struct.hpp:962
nstd::string messageServerId
消息服务器 ID
Definition v2_nim_def_struct.hpp:956
Definition v2_nim_def_struct.hpp:567
nstd::optional< nstd::string > excludeMessageServerId
锚点消息 ServerId ,该消息必须处于端点,暨消息时间必须等于 beginTime 或 endTime
Definition v2_nim_def_struct.hpp:575
V2NIMMessageRefer messageRefer
需要查询的消息引用,如果该消息为根消息,则参数为当前消息
Definition v2_nim_def_struct.hpp:569
nstd::optional< uint64_t > endTime
查询结束时间
Definition v2_nim_def_struct.hpp:573
nstd::optional< uint64_t > beginTime
查询开始时间,小于等于 endTime
Definition v2_nim_def_struct.hpp:571
nstd::optional< V2NIMQueryDirection > direction
消息查询方向,如果其它参数都不填
Definition v2_nim_def_struct.hpp:579
nstd::optional< uint32_t > limit
每次查询条数,默认 50
Definition v2_nim_def_struct.hpp:577
Definition v2_nim_def_struct.hpp:742
nstd::vector< V2NIMMessage > replyList
消息回复列表
Definition v2_nim_def_struct.hpp:750
V2NIMMessage message
根消息
Definition v2_nim_def_struct.hpp:744
uint32_t replyCount
获取 thread 聊天里的总回复数
Definition v2_nim_def_struct.hpp:748
uint64_t timestamp
thread 聊天里最后一条消息的时间戳
Definition v2_nim_def_struct.hpp:746
取消订阅选项
Definition v2_nim_def_struct.hpp:2406
nstd::optional< nstd::vector< nstd::string > > accountIds
取消订阅的成员列表,为空则表示取消所有订阅的成员,否则取消指定的成员。单次数量不超过 100,超过默认截取前 100
Definition v2_nim_def_struct.hpp:2408
Definition v2_nim_def_struct.hpp:1519
nstd::optional< nstd::string > teamNick
设置的群昵称
Definition v2_nim_def_struct.hpp:1521
nstd::optional< nstd::string > serverExtension
设置的群成员扩展字段
Definition v2_nim_def_struct.hpp:1523
Definition v2_nim_def_struct.hpp:216
nstd::optional< V2NIMTeamJoinMode > joinMode
申请入群模式
Definition v2_nim_def_struct.hpp:230
nstd::optional< V2NIMTeamAgreeMode > agreeMode
被邀请人入群模式
Definition v2_nim_def_struct.hpp:232
nstd::optional< nstd::string > avatar
群组头像
Definition v2_nim_def_struct.hpp:226
nstd::optional< nstd::string > intro
群组介绍
Definition v2_nim_def_struct.hpp:222
nstd::optional< V2NIMTeamUpdateExtensionMode > updateExtensionMode
群组扩展字段修改模式
Definition v2_nim_def_struct.hpp:238
nstd::optional< V2NIMTeamInviteMode > inviteMode
群组邀请模式
Definition v2_nim_def_struct.hpp:234
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition v2_nim_def_struct.hpp:220
nstd::optional< nstd::string > announcement
群组公告
Definition v2_nim_def_struct.hpp:224
nstd::optional< nstd::string > name
新修改群组名称
Definition v2_nim_def_struct.hpp:218
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition v2_nim_def_struct.hpp:228
nstd::optional< V2NIMTeamUpdateInfoMode > updateInfoMode
群组资料修改模式
Definition v2_nim_def_struct.hpp:236
群组信息更新信息
Definition v2_nim_def_struct.hpp:242
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由 openApi 设置
Definition v2_nim_def_struct.hpp:246
nstd::optional< V2NIMTeamChatBannedMode > chatBannedMode
群禁言状态
Definition v2_nim_def_struct.hpp:244
Definition v2_nim_def_struct.hpp:2081
nstd::string filePath
文件地址
Definition v2_nim_def_struct.hpp:2083
nstd::string sceneName
场景名
Definition v2_nim_def_struct.hpp:2085
Definition v2_nim_def_struct.hpp:2088
V2NIMUploadFileParams uploadParams
上传任务参数
Definition v2_nim_def_struct.hpp:2092
nstd::string taskId
上传任务 ID
Definition v2_nim_def_struct.hpp:2090
Definition v2_nim_def_struct.hpp:1557
nstd::optional< nstd::string > birthday
用户生日
Definition v2_nim_def_struct.hpp:1569
nstd::optional< nstd::string > avatar
用户头像
Definition v2_nim_def_struct.hpp:1563
uint64_t createTime
用户资料创建时间
Definition v2_nim_def_struct.hpp:1577
nstd::optional< nstd::string > email
用户邮箱
Definition v2_nim_def_struct.hpp:1567
uint64_t updateTime
用户资料更新时间
Definition v2_nim_def_struct.hpp:1579
nstd::string accountId
账号 ID
Definition v2_nim_def_struct.hpp:1559
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1575
nstd::optional< nstd::string > name
用户昵称
Definition v2_nim_def_struct.hpp:1561
nstd::optional< uint32_t > gender
用户性别
Definition v2_nim_def_struct.hpp:1573
nstd::optional< nstd::string > mobile
用户手机号
Definition v2_nim_def_struct.hpp:1571
nstd::optional< nstd::string > sign
用户签名
Definition v2_nim_def_struct.hpp:1565
Definition v2_nim_def_struct.hpp:1855
nstd::string senderAvatar
发送方头像
Definition v2_nim_def_struct.hpp:1861
nstd::string senderNick
发送方昵称
Definition v2_nim_def_struct.hpp:1859
nstd::string senderExtension
发送方扩展字段
Definition v2_nim_def_struct.hpp:1863
uint64_t userInfoTimestamp
消息发送者 uinfo 的最后更新时间
Definition v2_nim_def_struct.hpp:1857
用户搜索选项
Definition v2_nim_def_struct.hpp:1602
bool searchMobile
是否搜索手机号
Definition v2_nim_def_struct.hpp:1610
bool searchAccountId
是否搜索用户账号
Definition v2_nim_def_struct.hpp:1608
bool searchName
是否搜索用户昵称
Definition v2_nim_def_struct.hpp:1606
nstd::string keyword
搜索关键字
Definition v2_nim_def_struct.hpp:1604
事件订阅用户状态
Definition v2_nim_def_struct.hpp:2446
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition v2_nim_def_struct.hpp:2460
uint32_t statusType
用户状态类型
Definition v2_nim_def_struct.hpp:2450
time_t publishTime
用户发布状态的发布时间(服务器时间)
Definition v2_nim_def_struct.hpp:2454
nstd::string accountId
用户账号 ID
Definition v2_nim_def_struct.hpp:2448
nstd::optional< nstd::string > uniqueId
每次发布时会生成一个唯一 ID,发布自定义事件时会生成该参数,如果 ID 相同则表示同一个事件
Definition v2_nim_def_struct.hpp:2456
V2NIMLoginClientType clientType
用户发布状态对应的终端 V2NIMLoginClientType
Definition v2_nim_def_struct.hpp:2452
nstd::optional< uint32_t > duration
事件的有效期
Definition v2_nim_def_struct.hpp:2458
nstd::optional< nstd::string > serverExtension
获取预留状态中的配置信息,由服务端填入 JSON array 格式
Definition v2_nim_def_struct.hpp:2462
用户状态订阅结果
Definition v2_nim_def_struct.hpp:2436
time_t subscribeTime
用户状态发布时的时间
Definition v2_nim_def_struct.hpp:2442
nstd::string accountId
查询的用户账号
Definition v2_nim_def_struct.hpp:2438
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 30 天
Definition v2_nim_def_struct.hpp:2440
Definition v2_nim_def_struct.hpp:1582
nstd::optional< nstd::string > email
用户邮箱
Definition v2_nim_def_struct.hpp:1590
nstd::optional< nstd::string > mobile
用户手机号
Definition v2_nim_def_struct.hpp:1594
nstd::optional< uint32_t > gender
用户性别
Definition v2_nim_def_struct.hpp:1596
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition v2_nim_def_struct.hpp:1598
nstd::optional< nstd::string > sign
用户签名
Definition v2_nim_def_struct.hpp:1588
nstd::optional< nstd::string > avatar
用户头像
Definition v2_nim_def_struct.hpp:1586
nstd::optional< nstd::string > birthday
用户生日
Definition v2_nim_def_struct.hpp:1592
nstd::optional< nstd::string > name
用户昵称
Definition v2_nim_def_struct.hpp:1584
Definition v2_nim_def_struct.hpp:1351
nstd::string voiceUrl
语音 url, 若为空则根据 voicePath 自动上传
Definition v2_nim_def_struct.hpp:1355
nstd::string sampleRate
采样率
Definition v2_nim_def_struct.hpp:1359
nstd::string voicePath
本地语音文件路径, 若为空则使用 url
Definition v2_nim_def_struct.hpp:1353
nstd::string mimeType
音频类型, aac, wav, mp3, amr等
Definition v2_nim_def_struct.hpp:1357
nstd::string sceneName
文件存储场景
Definition v2_nim_def_struct.hpp:1363
uint64_t duration
语音时长, 单位毫秒
Definition v2_nim_def_struct.hpp:1361