NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
v2_nim_def_struct.hpp
浏览该文件的文档.
1#ifndef V2_NIM_DEF_STRUCT_H
2#define V2_NIM_DEF_STRUCT_H
3#include "v2_nim_def_enum.hpp"
4
5namespace v2 {
6
7struct V2NIMError {
14 V2NIMError() = default;
17};
18
19struct V2NIMSize {
21 int32_t width{0};
23 int32_t height{0};
24};
25
35};
36
44};
45
81};
82
87 bool enableBackup{true};
89 bool enableRestore{true};
94};
95
98 bool useHttps{true};
100 bool useHttpdns{true};
102 uint32_t customClientType{0};
110 bool disableAppNap{true};
112 bool enableCompass{true};
116 uint32_t sdkType{0};
119};
120
136};
137
142 uint64_t expireTime{0};
143};
144
151 uint64_t enterTime{0};
153 uint32_t clientType{0};
154};
155
172 bool isOnline{true};
174 bool blocked{false};
176 bool chatBanned{false};
178 bool tempChatBanned{false};
186 uint64_t enterTime{0};
188 uint64_t updateTime{0};
190 bool valid{true};
193};
194
210};
211
235};
236
243};
244
250 uint32_t duration;
251};
252
265};
266
267// noreflection
273 virtual ~V2NIMMessageAttachment() = default;
274};
275
276// noreflection
280 uint64_t size{0};
295};
296
297// noreflection
301 uint32_t width{0};
303 uint32_t height{0};
304};
305
306// noreflection
310 uint32_t duration{0};
311};
312
313// noreflection
317 uint32_t duration{0};
319 uint32_t width{0};
321 uint32_t height{0};
322};
323
324// noreflection
328 double latitude{0};
330 double longitude{0};
333};
334
335// noreflection
339 int32_t type{0};
343 int32_t status{0};
346};
347
348// noreflection
358 bool chatBanned{false};
361};
362
363// noreflection
386};
387
388// noreflection
394 uint64_t messageTime{0};
395};
396
397// noreflection
404};
405
406// noreflection
410 bool chatBanned{false};
412 bool tempChatBanned{false};
415};
416
417// noreflection
421 bool chatBanned{false};
423 bool tempChatBanned{false};
426};
427
428// noreflection
435};
436
439 bool pushEnabled{true};
441 bool pushNickEnabled{true};
447 bool forcePush{false};
452};
453
456 bool pushEnabled{true};
458 bool pushNickEnabled{true};
464 bool forcePush{false};
469};
470
473 bool antispamEnabled{true};
484};
485
488 bool antispamEnabled{true};
493};
494
504};
505
508 bool routeEnabled{true};
511};
512
515 bool routeEnabled{true};
518};
519
526 bool historyEnabled{true};
528 bool roamingEnabled{true};
532 bool offlineEnabled{true};
534 bool unreadEnabled{true};
535};
536
539 bool offlineEnabled{true};
541 bool unreadEnabled{true};
544};
545
560 uint64_t createTime{0};
561};
562
576};
577
580 uint64_t begin{0};
582 uint64_t end{0};
584 bool includeBegin{true};
586 bool includeEnd{false};
587};
588
594 bool readReceiptSent{false};
595};
596
602 int32_t type{0};
603};
604
611 int32_t type{0};
612};
613
623};
624
630};
631
643};
644
651 uint64_t createTime{0};
665 uint32_t subType{0};
697 bool isSelf{false};
704 operator V2NIMMessageRefer() const {
705 V2NIMMessageRefer messageRefer;
706 messageRefer.senderId = senderId;
707 messageRefer.receiverId = receiverId;
708 messageRefer.messageClientId = messageClientId;
709 messageRefer.messageServerId = messageServerId;
710 messageRefer.conversationType = conversationType;
711 messageRefer.conversationId = conversationId;
712 messageRefer.createTime = createTime;
713 return messageRefer;
714 }
715};
716
736};
737
742 uint64_t timestamp{0};
744 uint32_t replyCount{0};
747};
748
757 uint64_t timestamp{0};
768};
769
772 uint64_t id;
776 uint64_t timestamp;
779};
780
790};
791
797};
798
815};
816
828};
829
834 bool inclusive{true};
838 bool newMemberVisible{false};
839};
840
860};
861
873};
874
888};
889
898 uint64_t createTime{0};
900 uint64_t updateTime{0};
901};
902
908};
909
919};
920
926};
927
935};
936
946};
947
956 uint32_t readCount{0};
958 uint32_t unreadCount{0};
961};
962
970};
971
976 uint64_t timestamp{0};
977};
978
984};
985
992 uint64_t beginTime{0};
994 uint64_t endTime{0};
1000 bool reverse{false};
1004 bool strictMode{false};
1006 bool onlyQueryLocal{false};
1007};
1008
1013 bool deleteRoam{true};
1015 bool onlineSync{false};
1018};
1019
1022 bool needPush{true};
1024 bool needBadge{true};
1031};
1032
1039 uint64_t index{0};
1044};
1045
1051};
1052
1057 uint64_t deleteTime{0};
1060};
1061
1066 uint64_t deleteTime{0};
1069};
1070
1075 uint32_t collectionType{0};
1083 uint64_t createTime{0};
1085 uint64_t updateTime{0};
1086};
1087
1090 uint32_t collectionType{0};
1097};
1098
1101 uint64_t beginTime{0};
1103 uint64_t endTime{0};
1111 uint32_t collectionType{0};
1112};
1113
1116 uint32_t totalCount{0};
1119};
1120
1125
1130
1136
1142
1148
1151 uint32_t retryCount{3};
1155 bool forceMode{false};
1164};
1165
1172 uint64_t timestamp{0};
1176 uint32_t customClientType{0};
1181};
1182
1191 uint32_t customClientType{0};
1192};
1193
1199};
1200
1228};
1229
1240 bool mute{false};
1242 bool stickTop{false};
1252 uint32_t unreadCount{0};
1254 uint64_t sortOrder{0};
1256 uint64_t createTime{0};
1258 uint64_t updateTime{0};
1259};
1260
1263 uint64_t offset{0};
1265 bool finished{false};
1268};
1269
1275};
1276
1280};
1281
1288 bool onlyUnread{false};
1289};
1290
1297 bool ignoreMuted{false};
1298};
1299
1308 uint64_t createTime{0};
1310 uint64_t updateTime{0};
1311};
1312
1318};
1319
1324 uint64_t beginTime{0};
1326 uint64_t endTime{0};
1343};
1344
1355 uint64_t duration{0};
1358};
1359
1370 uint32_t memberLimit{0};
1372 uint32_t memberCount{0};
1374 uint64_t createTime{0};
1376 uint64_t updateTime{0};
1400 bool isValidTeam{true};
1402 uint32_t bits{0};
1405};
1406
1434};
1435
1436// @internal
1462};
1463
1491};
1492
1497 bool onlyChatBanned{false};
1504};
1505
1511};
1512
1518};
1519
1522 bool finished{false};
1527};
1528
1541 uint64_t timestamp{0};
1544};
1545
1549};
1550
1571 uint64_t createTime{0};
1573 uint64_t updateTime{0};
1574};
1575
1593};
1594
1600 bool searchName{true};
1602 bool searchAccountId{false};
1604 bool searchMobile{false};
1605};
1606
1626};
1627
1633};
1634
1647 uint64_t timestamp{0};
1649 bool read{false};
1650};
1651
1654 bool deleteAlias{false};
1655};
1656
1662};
1663
1668 bool searchAlias{true};
1670 bool searchAccountId{false};
1671};
1672
1677 uint64_t offset;
1682};
1683
1691 // 起始位置,首次传空, 后续传上次返回的 nextToken
1697};
1698
1703 uint64_t offset{0};
1705 bool finished{false};
1706};
1707
1710 uint64_t offset;
1715};
1716
1721 uint64_t offset{0};
1723 bool finished{false};
1724};
1725
1728 bool showDetail{false};
1730 bool dndOn{false};
1732 uint32_t fromH{0};
1734 uint32_t fromM{0};
1736 uint32_t toH{0};
1738 uint32_t toM{0};
1739};
1740
1748};
1749
1755};
1756
1764};
1765
1771};
1772
1787 bool anonymousMode{false};
1800};
1801
1812 bool isValidRoom{true};
1820 uint32_t onlineUserCount{0};
1822 bool chatBanned{false};
1823};
1824
1826 bool enabled{false};
1827 std::vector<std::string> cdnUrls;
1828 uint64_t timestamp;
1829 uint64_t pollingInterval; // seconds
1830 uint32_t decryptType;
1831 std::string decryptKey;
1832 uint64_t pollingTimeout; // milliseconds
1833};
1834
1840};
1841
1847};
1848
1858};
1859
1862 bool historyEnabled{true};
1864 bool highPriority{false};
1865};
1866
1873 uint64_t createTime{0};
1879 bool isSelf{false};
1887 uint32_t subType{0};
1908};
1909
1927};
1928
1936};
1937
1942 bool onlyBlocked{false};
1944 bool onlyChatBanned{false};
1946 bool onlyOnline{false};
1951};
1952
1957 bool finished{false};
1960};
1961
1968 uint64_t beginTime{0};
1971};
1972
1980};
1981
1994 bool persistence{false};
1995};
1996
2003 uint64_t duration{0};
2008};
2009
2019};
2020
2028};
2029
2036 uint64_t beginTime{0};
2038 uint64_t endTime{0};
2043};
2044
2047 virtual nstd::shared_ptr<V2NIMMessageAttachment> parse(const nstd::string& attach, const int32_t& subType) = 0;
2049};
2050
2052 std::string key;
2055 std::string config;
2056};
2057
2059 std::string name;
2060 std::string config;
2061 std::vector<V2NIMClientAntispamThesaurusItem> items;
2062};
2063
2070 bool transient{false};
2073};
2074
2080};
2081
2087};
2088
2102};
2103
2104struct V2NIMAIUser : public V2NIMUser {
2109};
2110
2123};
2124
2130};
2131
2139};
2140
2144 bool pushEnabled{false};
2151};
2152
2161};
2162
2183};
2184
2196 time_t createTime{0};
2198 time_t expireTime{0};
2201};
2202
2208 int64_t uid{0};
2210 time_t joinTime{0};
2212 time_t expireTime{0};
2215};
2216
2223};
2224
2232};
2233
2241 int32_t callStatus{0};
2242};
2243
2258};
2259
2268};
2269
2280};
2281
2296};
2297
2310};
2311
2324};
2325
2338};
2339
2351 uint64_t time;
2376};
2377
2385 bool immediateSync{false};
2386};
2387
2392};
2393
2397 uint32_t statusType{0};
2403 bool onlineOnly{true};
2405 bool multiSync{false};
2406};
2407
2416};
2417
2423 uint32_t duration;
2426};
2427
2433 uint32_t statusType{0};
2437 time_t publishTime{0};
2446};
2447
2451 virtual void parse(const nstd::string& attach) = 0;
2452};
2453
2456 virtual nstd::shared_ptr<V2NIMMessageAttachment> parse(const nstd::string& attach, const int32_t& subType) = 0;
2458};
2459
2472};
2473
2480};
2481
2489 time_t time;
2490};
2491
2512};
2513
2521 uint32_t count{0};
2522};
2523
2527 uint32_t count{0};
2537};
2538
2539} // namespace v2
2540
2541#endif
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:1187
@ V2NIM_KICKED_OFFLINE_REASON_CLIENT_EXCLUSIVE
多端登录互踢
Definition: v2_nim_def_enum.hpp:1189
V2NIMTeamUpdateExtensionMode
Definition: v2_nim_def_enum.hpp:1314
@ V2NIM_TEAM_UPDATE_EXTENSION_MODE_MANAGER
群主/管理员可以修改群组扩展字段
Definition: v2_nim_def_enum.hpp:1316
V2NIMMessageQuickCommentType
Definition: v2_nim_def_enum.hpp:1097
@ V2NIM_MESSAGE_QUICK_COMMENT_TYPE_ADD
添加快捷评论
Definition: v2_nim_def_enum.hpp:1099
V2NIMSignallingChannelType
Definition: v2_nim_def_enum.hpp:1540
@ V2NIM_SIGNALLING_CHANNEL_TYPE_UNKNOWN
未知频道类型
Definition: v2_nim_def_enum.hpp:1542
static const uint32_t V2NIM_DEFAULT_LOG_RESERVE_DAYS
Definition: v2_nim_def_enum.hpp:1603
V2NIMProxyRequestMethod
Definition: v2_nim_def_enum.hpp:1584
static const uint32_t V2NIM_DEFAULT_JOIN_ACTION_QUERY_LIMIT
Definition: v2_nim_def_enum.hpp:1605
V2NIMChatroomMemberRole
Definition: v2_nim_def_enum.hpp:1411
@ V2NIM_CHATROOM_MEMBER_ROLE_NORMAL
普通成员
Definition: v2_nim_def_enum.hpp:1413
V2NIMMessageAttachmentUploadState
Definition: v2_nim_def_enum.hpp:965
@ V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_UNKNOWN
未知, 不存在附件或不需要上传的附件
Definition: v2_nim_def_enum.hpp:967
V2NIMTeamUpdateInfoMode
Definition: v2_nim_def_enum.hpp:1298
@ V2NIM_TEAM_UPDATE_INFO_MODE_MANAGER
群主/管理员可以修改群组资料
Definition: v2_nim_def_enum.hpp:1300
V2NIMMessageRevokeType
Definition: v2_nim_def_enum.hpp:1120
@ V2NIM_MESSAGE_REVOKE_TYPE_UNDEFINED
未定义
Definition: v2_nim_def_enum.hpp:1122
V2NIMSortOrder
Definition: v2_nim_def_enum.hpp:1104
@ V2NIM_SORT_ORDER_DESC
按时间降序排序
Definition: v2_nim_def_enum.hpp:1106
V2NIMClientAntispamThesaurusMatchType
Definition: v2_nim_def_enum.hpp:1261
@ V2NIM_CLIENT_ANTISPAM_THESAURUS_MATCH_TYPE_WORD
Definition: v2_nim_def_enum.hpp:1262
V2NIMDataSyncLevel
Definition: v2_nim_def_enum.hpp:1216
@ V2NIM_DATA_SYNC_LEVEL_FULL
完全同步
Definition: v2_nim_def_enum.hpp:1218
V2NIMAIModelRoleType
Definition: v2_nim_def_enum.hpp:1520
V2NIMAsymmetricEncryptionAlgorithm
Definition: v2_nim_def_enum.hpp:860
@ V2NIM_ASYMMETRIC_ENCRYPTION_ALGORITHM_RSA
RSA
Definition: v2_nim_def_enum.hpp:862
V2NIMClientAntispamOperateType
Definition: v2_nim_def_enum.hpp:1250
@ V2NIM_CLIENT_ANTISPAM_OPERATE_NONE
无操作
Definition: v2_nim_def_enum.hpp:1252
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:1615
static const uint32_t V2NIM_DEFAULT_FRIEND_APPLICATION_QUERY_LIMIT
Definition: v2_nim_def_enum.hpp:1606
V2NIMFriendAddApplicationStatus
Definition: v2_nim_def_enum.hpp:1384
@ V2NIM_FRIEND_ADD_APPLICATION_STATUS_INIT
未处理
Definition: v2_nim_def_enum.hpp:1386
V2NIMAIModelType
Definition: v2_nim_def_enum.hpp:1529
V2NIMChatroomQueueLevelMode
Definition: v2_nim_def_enum.hpp:1404
@ V2NIM_CHATROOM_QUEUE_LEVEL_MODE_ANY
所有人都有权限操作
Definition: v2_nim_def_enum.hpp:1406
V2NIMMessageAttachmentType
Definition: v2_nim_def_enum.hpp:1487
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_UNIVERSAL
通用
Definition: v2_nim_def_enum.hpp:1489
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_LOCATION
位置
Definition: v2_nim_def_enum.hpp:1497
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_AUDIO
语音
Definition: v2_nim_def_enum.hpp:1493
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_TEAM_NOTIFICATION
群通知
Definition: v2_nim_def_enum.hpp:1499
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ENTER_NOTIFICATION
聊天室成员进入
Definition: v2_nim_def_enum.hpp:1513
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_CHAT_BANNED_NOTIFICATION
聊天室禁言
Definition: v2_nim_def_enum.hpp:1511
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_FILE
文件
Definition: v2_nim_def_enum.hpp:1501
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CALL
话单
Definition: v2_nim_def_enum.hpp:1503
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_QUEUE_NOTIFICATION
聊天室队列变更
Definition: v2_nim_def_enum.hpp:1509
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MEMBER_ROLE_UPDATE_NOTIFICATION
聊天室成员角色变更
Definition: v2_nim_def_enum.hpp:1515
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_VIDEO
视频
Definition: v2_nim_def_enum.hpp:1495
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_NOTIFICATION
聊天室通知
Definition: v2_nim_def_enum.hpp:1505
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CUSTOM
自定义消息
Definition: v2_nim_def_enum.hpp:1517
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_CHATROOM_MESSAGE_REVOKE_NOTIFICATION
聊天室消息撤回
Definition: v2_nim_def_enum.hpp:1507
@ V2NIM_MESSAGE_ATTACHMENT_TYPE_IMAGE
图片
Definition: v2_nim_def_enum.hpp:1491
V2NIMFCSAuthType
Definition: v2_nim_def_enum.hpp:896
@ V2NIM_FCS_AUTH_TYPE_NONE
无鉴权
Definition: v2_nim_def_enum.hpp:898
V2NIMTeamJoinActionStatus
Definition: v2_nim_def_enum.hpp:1373
@ V2NIM_TEAM_JOIN_ACTION_STATUS_INIT
未处理
Definition: v2_nim_def_enum.hpp:1375
V2NIMSDKLogLevel
Definition: v2_nim_def_enum.hpp:883
@ V2NIM_SDK_LOG_LEVEL_APP
应用
Definition: v2_nim_def_enum.hpp:891
static const uint32_t V2NIM_DEFAULT_SEARCH_MESSAGE_LIST_LIMIT
Definition: v2_nim_def_enum.hpp:1611
static const uint32_t V2NIM_DEFAULT_SEARCH_LOCAL_MESSAGE_LIST_LIMIT
Definition: v2_nim_def_enum.hpp:1612
V2NIMLastMessageState
Definition: v2_nim_def_enum.hpp:956
@ V2NIM_MESSAGE_STATE_DEFAULT
默认
Definition: v2_nim_def_enum.hpp:958
static const uint32_t V2NIM_DEFAULT_CHATROOM_QUERY_LIMIT
Definition: v2_nim_def_enum.hpp:1610
V2NIMTeamChatBannedMode
Definition: v2_nim_def_enum.hpp:1305
@ V2NIM_TEAM_CHAT_BANNED_MODE_NONE
不禁言, 群组成员可以自由发言
Definition: v2_nim_def_enum.hpp:1307
V2NIMTeamJoinActionType
Definition: v2_nim_def_enum.hpp:1339
@ V2NIM_TEAM_JOIN_ACTION_TYPE_APPLICATION
申请入群
Definition: v2_nim_def_enum.hpp:1341
V2NIMTeamAgreeMode
Definition: v2_nim_def_enum.hpp:1284
@ V2NIM_TEAM_AGREE_MODE_AUTH
需要被邀请人同意
Definition: v2_nim_def_enum.hpp:1286
static const char * V2NIM_STORAGE_SCENE_NAME_DEFAULT_IM
Definition: v2_nim_def_enum.hpp:1628
V2NIMChatroomKickedReason
Definition: v2_nim_def_enum.hpp:1426
@ V2NIM_CHATROOM_KICKED_REASON_UNKNOWN
未知
Definition: v2_nim_def_enum.hpp:1428
V2NIMLoginClientType
Definition: v2_nim_def_enum.hpp:1155
@ V2NIM_LOGIN_CLIENT_TYPE_UNKNOWN
未知类型
Definition: v2_nim_def_enum.hpp:1157
V2NIMMessageClientAntispamOperatorType
Definition: v2_nim_def_enum.hpp:1135
@ V2NIM_MESSAGE_CLIENT_ANTISPAM_OPERATOR_NONE
无操作
Definition: v2_nim_def_enum.hpp:1137
V2NIMMessageType
Definition: v2_nim_def_enum.hpp:920
@ V2NIM_MESSAGE_TYPE_TEXT
文本
Definition: v2_nim_def_enum.hpp:922
V2NIMDownloadAttachmentType
Definition: v2_nim_def_enum.hpp:1478
@ V2NIM_DOWNLOAD_ATTACHMENT_TYPE_SOURCE
原始资源,支持全部有附件的类型
Definition: v2_nim_def_enum.hpp:1480
V2NIMTeamType
Definition: v2_nim_def_enum.hpp:1266
@ V2NIM_TEAM_TYPE_NORMAL
高级群
Definition: v2_nim_def_enum.hpp:1270
V2NIMDataSyncType
Definition: v2_nim_def_enum.hpp:1223
@ V2NIM_DATA_SYNC_MAIN
同步主数据
Definition: v2_nim_def_enum.hpp:1225
V2NIMFriendAddMode
Definition: v2_nim_def_enum.hpp:1366
@ V2NIM_FRIEND_MODE_TYPE_ADD
直接添加对方为好友
Definition: v2_nim_def_enum.hpp:1368
V2NIMSymmetricEncryptionAlgorithm
Definition: v2_nim_def_enum.hpp:867
@ V2NIM_SYMMETRIC_ENCRYPTION_ALGORITHM_RC4
RC4
Definition: v2_nim_def_enum.hpp:869
static const uint32_t V2NIM_DEFAULT_MESSAGE_LIST_LIMIT
Definition: v2_nim_def_enum.hpp:1604
V2NIMSignallingEventType
信令频道事件类型
Definition: v2_nim_def_enum.hpp:1552
static const uint32_t V2NIM_DEFAULT_SUBSCRIBE_DURATION
Definition: v2_nim_def_enum.hpp:1616
V2NIMTeamInviteMode
Definition: v2_nim_def_enum.hpp:1291
@ V2NIM_TEAM_INVITE_MODE_MANAGER
群主, 管理员可以邀请其他人入群
Definition: v2_nim_def_enum.hpp:1293
V2NIMDataSyncState
Definition: v2_nim_def_enum.hpp:1232
@ V2NIM_DATA_SYNC_STATE_WAITING
等待同步
Definition: v2_nim_def_enum.hpp:1234
V2NIMMessageAIStatus
Definition: v2_nim_def_enum.hpp:1111
@ V2NIM_MESSAGE_AI_STATUS_UNKNOWN
未知
Definition: v2_nim_def_enum.hpp:1113
V2NIMConversationType
Definition: v2_nim_def_enum.hpp:909
@ V2NIM_CONVERSATION_TYPE_UNKNOWN
未知
Definition: v2_nim_def_enum.hpp:911
static const uint32_t V2NIM_DEFAULT_COLLECTION_LIST_LIMIT
Definition: v2_nim_def_enum.hpp:1607
V2NIMTeamJoinMode
Definition: v2_nim_def_enum.hpp:1275
@ V2NIM_TEAM_JOIN_MODE_APPLY
需申请, 群主或管理同意后加入
Definition: v2_nim_def_enum.hpp:1279
V2NIMMessageNotificationType
Definition: v2_nim_def_enum.hpp:976
@ V2NIM_MESSAGE_NOTIFICATION_TYPE_TEAM_INVITE
群拉人
Definition: v2_nim_def_enum.hpp:978
V2NIMLoginAuthType
Definition: v2_nim_def_enum.hpp:1146
@ V2NIM_LOGIN_AUTH_TYPE_DEFAULT
默认
Definition: v2_nim_def_enum.hpp:1148
V2NIMQueryDirection
Definition: v2_nim_def_enum.hpp:1090
@ V2NIM_QUERY_DIRECTION_DESC
按时间降序查询
Definition: v2_nim_def_enum.hpp:1092
static const uint64_t DEFAULT_PROTOCOL_TIMEOUT
Definition: v2_nim_def_enum.hpp:1618
V2NIMMessageSendingState
Definition: v2_nim_def_enum.hpp:945
@ V2NIM_MESSAGE_SENDING_STATE_UNKNOWN
未知, 如果消息不是从这个端发送的
Definition: v2_nim_def_enum.hpp:947
V2NIMChatroomMessageNotificationType
Definition: v2_nim_def_enum.hpp:1023
@ V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_ENTER
成员进入聊天室
Definition: v2_nim_def_enum.hpp:1025
V2NIMIPProtocolVersion
Definition: v2_nim_def_enum.hpp:851
@ V2NIM_IP_PROTOCOL_VERSION_IPV4
IPv4
Definition: v2_nim_def_enum.hpp:855
static const uint32_t V2NIM_DEFAULT_TEAM_MEMBER_LIST_LIMIT
Definition: v2_nim_def_enum.hpp:1609
V2NIMSQLCipherVersion
Definition: v2_nim_def_enum.hpp:876
@ V2NIM_SQLCIPHER_VERSION_4
SQLCipher 4
Definition: v2_nim_def_enum.hpp:880
V2NIMMessagePinState
Definition: v2_nim_def_enum.hpp:1081
@ V2NIM_MESSAGE_PIN_STEATE_NOT_PINNED
未 pin
Definition: v2_nim_def_enum.hpp:1083
static const uint64_t DEFAULT_LINK_TIMEOUT
Definition: v2_nim_def_enum.hpp:1617
V2NIMSearchKeywordMathType
搜索关键字匹配条件
Definition: v2_nim_def_enum.hpp:1596
@ V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition: v2_nim_def_enum.hpp:1598
V2NIMChatroomQueueChangeType
Definition: v2_nim_def_enum.hpp:1064
Definition: ne_stl_optional.h:16
Definition: ne_stl_bind.h:132
调用大模型的请求内容
Definition: v2_nim_def_struct.hpp:598
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition: v2_nim_def_struct.hpp:602
nstd::string msg
请求/响应的文本内容
Definition: v2_nim_def_struct.hpp:600
Definition: v2_nim_def_struct.hpp:605
int32_t type
类型, 暂时只有 0, 代表文本, 预留扩展能力
Definition: v2_nim_def_struct.hpp:611
nstd::string msg
上下文的内容
Definition: v2_nim_def_struct.hpp:609
V2NIMAIModelRoleType role
上下文内容的角色
Definition: v2_nim_def_struct.hpp:607
Definition: v2_nim_def_struct.hpp:781
nstd::optional< V2NIMAIModelCallContent > content
请求 AI 的回复
Definition: v2_nim_def_struct.hpp:789
nstd::string accountId
数字人的账号 ID
Definition: v2_nim_def_struct.hpp:785
nstd::string requestId
本次响应的标识
Definition: v2_nim_def_struct.hpp:787
uint32_t code
AI 响应的状态码
Definition: v2_nim_def_struct.hpp:783
Definition: v2_nim_def_struct.hpp:2089
nstd::optional< nstd::string > temperature
取值范围(0, 2), 用于控制随机性和多样性的程度。
Definition: v2_nim_def_struct.hpp:2101
nstd::string model
具体大模型版本模型名
Definition: v2_nim_def_struct.hpp:2091
nstd::optional< uint32_t > maxTokens
模型最大tokens数量
Definition: v2_nim_def_struct.hpp:2097
nstd::optional< nstd::string > topP
取值范围(0, 1), 生成时,核采样方法的概率阈值。
Definition: v2_nim_def_struct.hpp:2099
nstd::string prompt
提示词
Definition: v2_nim_def_struct.hpp:2093
nstd::optional< nstd::vector< nstd::string > > promptKeys
提示词对应的变量
Definition: v2_nim_def_struct.hpp:2095
Definition: v2_nim_def_struct.hpp:614
nstd::optional< nstd::string > prompt
提示词
Definition: v2_nim_def_struct.hpp:616
nstd::optional< int32_t > maxTokens
模型最大 tokens 数量
Definition: v2_nim_def_struct.hpp:618
nstd::optional< double > temperature
取值范围 (0, 2), 用于控制随机性和多样性的程度。
Definition: v2_nim_def_struct.hpp:622
nstd::optional< double > topP
取值范围 (0, 1), 生成时, 核采样方法的概率阈值。
Definition: v2_nim_def_struct.hpp:620
Definition: v2_nim_def_struct.hpp:2104
V2NIMAIModelConfig modelConfig
模型相关配置文件
Definition: v2_nim_def_struct.hpp:2108
V2NIMAIModelType modelType
模型选择
Definition: v2_nim_def_struct.hpp:2106
Definition: v2_nim_def_struct.hpp:1088
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1094
uint32_t collectionType
收藏类型
Definition: v2_nim_def_struct.hpp:1090
nstd::string collectionData
收藏数据
Definition: v2_nim_def_struct.hpp:1092
nstd::optional< nstd::string > uniqueId
去重唯一 ID,如果 ID 相同,则不会新增收藏,只更新之前的收藏内容
Definition: v2_nim_def_struct.hpp:1096
Definition: v2_nim_def_struct.hpp:1546
nstd::string antispamBusinessId
易盾业务 ID
Definition: v2_nim_def_struct.hpp:1548
Definition: v2_nim_def_struct.hpp:96
bool disableAppNap
是否禁用 macOS 下的 App Nap 功能
Definition: v2_nim_def_struct.hpp:110
uint32_t sdkType
Definition: v2_nim_def_struct.hpp:116
nstd::string customTag
登录自定义信息, 最大 32 个字符
Definition: v2_nim_def_struct.hpp:104
uint32_t customClientType
自定义客户端类型
Definition: v2_nim_def_struct.hpp:102
uint32_t logReserveDays
日志保留天数
Definition: v2_nim_def_struct.hpp:106
nstd::optional< nstd::string > compassDataEndpoint
云信指南针数据上报地址,为空则使用默认地址
Definition: v2_nim_def_struct.hpp:114
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:118
V2NIMSDKLogLevel sdkLogLevel
SDK日志级别
Definition: v2_nim_def_struct.hpp:108
Definition: v2_nim_def_struct.hpp:770
uint64_t id
广播通知 ID
Definition: v2_nim_def_struct.hpp:772
uint64_t timestamp
广播通知时间戳
Definition: v2_nim_def_struct.hpp:776
nstd::string content
广播通知内容
Definition: v2_nim_def_struct.hpp:778
nstd::string senderId
广播通知发送者账号
Definition: v2_nim_def_struct.hpp:774
聊天室自定义消息附件解析器
Definition: v2_nim_def_struct.hpp:2046
virtual ~V2NIMChatRoomMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition: v2_nim_def_struct.hpp:1825
uint64_t pollingInterval
Definition: v2_nim_def_struct.hpp:1829
uint64_t timestamp
Definition: v2_nim_def_struct.hpp:1828
uint32_t decryptType
Definition: v2_nim_def_struct.hpp:1830
std::string decryptKey
Definition: v2_nim_def_struct.hpp:1831
bool enabled
Definition: v2_nim_def_struct.hpp:1826
std::vector< std::string > cdnUrls
Definition: v2_nim_def_struct.hpp:1827
uint64_t pollingTimeout
Definition: v2_nim_def_struct.hpp:1832
Definition: v2_nim_def_struct.hpp:407
V2NIMChatroomChatBannedNotificationAttachment()
Definition: v2_nim_def_struct.hpp:408
bool tempChatBanned
成员是否被临时禁言
Definition: v2_nim_def_struct.hpp:412
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition: v2_nim_def_struct.hpp:414
bool chatBanned
成员是否被禁言
Definition: v2_nim_def_struct.hpp:410
Definition: v2_nim_def_struct.hpp:145
nstd::string roomAvatar
进入聊天室后显示的头像
Definition: v2_nim_def_struct.hpp:149
uint32_t clientType
进入的终端类型
Definition: v2_nim_def_struct.hpp:153
nstd::string roomNick
进入聊天室后显示的昵称
Definition: v2_nim_def_struct.hpp:147
uint64_t enterTime
用户进入聊天室的时间点
Definition: v2_nim_def_struct.hpp:151
Definition: v2_nim_def_struct.hpp:1773
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition: v2_nim_def_struct.hpp:1779
V2NIMAntispamConfig antispamConfig
反垃圾配置信息
Definition: v2_nim_def_struct.hpp:1799
nstd::string accountId
账号 ID
Definition: v2_nim_def_struct.hpp:1775
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition: v2_nim_def_struct.hpp:1781
nstd::string token
静态 token
Definition: v2_nim_def_struct.hpp:1777
nstd::optional< V2NIMChatroomLocationConfig > locationConfig
进入聊天室空间位置信息配置
Definition: v2_nim_def_struct.hpp:1797
V2NIMChatroomLinkProvider linkProvider
获取聊天室 link 链接地址
Definition: v2_nim_def_struct.hpp:1789
uint64_t timeout
登录超时, 单位毫秒
Definition: v2_nim_def_struct.hpp:1783
bool anonymousMode
匿名模式
Definition: v2_nim_def_struct.hpp:1787
V2NIMChatroomLoginOption loginOption
聊天室登录相关信息
Definition: v2_nim_def_struct.hpp:1785
V2NIMChatroomTagConfig tagConfig
进入聊天室标签信息配置
Definition: v2_nim_def_struct.hpp:1795
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition: v2_nim_def_struct.hpp:1793
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition: v2_nim_def_struct.hpp:1791
Definition: v2_nim_def_struct.hpp:1835
V2NIMChatroomInfo chatroom
聊天室信息
Definition: v2_nim_def_struct.hpp:1837
V2NIMChatroomMember selfMember
用户信息
Definition: v2_nim_def_struct.hpp:1839
Definition: v2_nim_def_struct.hpp:1802
nstd::string serverExtension
聊天室扩展字段
Definition: v2_nim_def_struct.hpp:1814
nstd::string announcement
聊天室公告
Definition: v2_nim_def_struct.hpp:1808
nstd::string roomId
聊天室 ID
Definition: v2_nim_def_struct.hpp:1804
bool isValidRoom
聊天室是否有效
Definition: v2_nim_def_struct.hpp:1812
bool chatBanned
聊天室禁言状态
Definition: v2_nim_def_struct.hpp:1822
nstd::string roomName
聊天室名称
Definition: v2_nim_def_struct.hpp:1806
nstd::string creatorAccountId
聊天室创建者账号 ID
Definition: v2_nim_def_struct.hpp:1818
V2NIMChatroomQueueLevelMode queueLevelMode
聊天室队列操作权限模式
Definition: v2_nim_def_struct.hpp:1816
uint32_t onlineUserCount
聊天室当前在线用户数量
Definition: v2_nim_def_struct.hpp:1820
nstd::string liveUrl
视频直播拉流地址
Definition: v2_nim_def_struct.hpp:1810
Definition: v2_nim_def_struct.hpp:1842
nstd::string serverExtension
被踢扩展字段
Definition: v2_nim_def_struct.hpp:1846
V2NIMChatroomKickedReason kickedReason
被踢原因
Definition: v2_nim_def_struct.hpp:1844
Definition: v2_nim_def_struct.hpp:1766
nstd::optional< double > distance
订阅的消息的距离
Definition: v2_nim_def_struct.hpp:1770
V2NIMLocationInfo locationInfo
空间坐标信息
Definition: v2_nim_def_struct.hpp:1768
Definition: v2_nim_def_struct.hpp:1741
V2NIMLoginAuthType authType
认证模式
Definition: v2_nim_def_struct.hpp:1743
V2NIMChatroomTokenProvider tokenProvider
token 获取回调
Definition: v2_nim_def_struct.hpp:1745
V2NIMChatroomLoginExtensionProvider loginExtensionProvider
登陆扩展回调
Definition: v2_nim_def_struct.hpp:1747
Definition: v2_nim_def_struct.hpp:418
bool tempChatBanned
成员是否被临时禁言
Definition: v2_nim_def_struct.hpp:423
bool chatBanned
成员是否被禁言
Definition: v2_nim_def_struct.hpp:421
V2NIMChatroomMemberEnterNotificationAttachment()
Definition: v2_nim_def_struct.hpp:419
uint64_t tempChatBannedDuration
成员临时禁言时长
Definition: v2_nim_def_struct.hpp:425
Definition: v2_nim_def_struct.hpp:156
nstd::string accountId
成员账号 ID
Definition: v2_nim_def_struct.hpp:160
nstd::string notifyTargetTags
登录登出通知标签
Definition: v2_nim_def_struct.hpp:184
uint64_t updateTime
更新时间
Definition: v2_nim_def_struct.hpp:188
nstd::string roomId
聊天室 ID
Definition: v2_nim_def_struct.hpp:158
bool valid
是否有效
Definition: v2_nim_def_struct.hpp:190
bool isOnline
用户是否在线
Definition: v2_nim_def_struct.hpp:172
uint64_t enterTime
用户进入聊天室的时间点
Definition: v2_nim_def_struct.hpp:186
nstd::vector< V2NIMChatroomEnterInfo > multiEnterInfo
多端登录信息
Definition: v2_nim_def_struct.hpp:192
uint64_t tempChatBannedDuration
临时禁言时长, 单位秒
Definition: v2_nim_def_struct.hpp:180
nstd::optional< nstd::string > roomAvatar
进入聊天室后显示的头像
Definition: v2_nim_def_struct.hpp:168
bool chatBanned
是否禁言
Definition: v2_nim_def_struct.hpp:176
nstd::optional< nstd::string > serverExtension
聊天室成员扩展字段
Definition: v2_nim_def_struct.hpp:170
nstd::vector< nstd::string > tags
登录标签
Definition: v2_nim_def_struct.hpp:182
bool tempChatBanned
是否临时禁言
Definition: v2_nim_def_struct.hpp:178
bool blocked
是否在黑名单中
Definition: v2_nim_def_struct.hpp:174
nstd::optional< nstd::string > roomNick
进入聊天室后显示的昵称
Definition: v2_nim_def_struct.hpp:166
nstd::optional< uint32_t > memberLevel
成员等级, 0 表示未设置
Definition: v2_nim_def_struct.hpp:164
V2NIMChatroomMemberRole memberRole
聊天室成员角色
Definition: v2_nim_def_struct.hpp:162
Definition: v2_nim_def_struct.hpp:1953
nstd::vector< V2NIMChatroomMember > memberList
拉取的成员列表
Definition: v2_nim_def_struct.hpp:1959
bool finished
数据是否拉取完毕
Definition: v2_nim_def_struct.hpp:1957
nstd::string pageToken
下一次查询的偏移量
Definition: v2_nim_def_struct.hpp:1955
Definition: v2_nim_def_struct.hpp:1938
bool onlyBlocked
是否只返回黑名单成员
Definition: v2_nim_def_struct.hpp:1942
nstd::string pageToken
偏移量
Definition: v2_nim_def_struct.hpp:1948
uint32_t limit
查询数量
Definition: v2_nim_def_struct.hpp:1950
bool onlyOnline
是否只查询在线成员
Definition: v2_nim_def_struct.hpp:1946
bool onlyChatBanned
是否只返回禁言用户
Definition: v2_nim_def_struct.hpp:1944
nstd::vector< V2NIMChatroomMemberRole > memberRoles
需要查询的成员类型
Definition: v2_nim_def_struct.hpp:1940
Definition: v2_nim_def_struct.hpp:429
V2NIMChatroomMemberRoleUpdateAttachment()
Definition: v2_nim_def_struct.hpp:430
V2NIMChatroomMember currentMember
当前的成员信息
Definition: v2_nim_def_struct.hpp:434
V2NIMChatroomMemberRole previousRole
之前的角色类型
Definition: v2_nim_def_struct.hpp:432
Definition: v2_nim_def_struct.hpp:1973
nstd::optional< uint32_t > memberLevel
设置用户等级
Definition: v2_nim_def_struct.hpp:1977
V2NIMChatroomMemberRole memberRole
设置的成员角色
Definition: v2_nim_def_struct.hpp:1975
nstd::optional< nstd::string > notificationExtension
通知扩展字段
Definition: v2_nim_def_struct.hpp:1979
Definition: v2_nim_def_struct.hpp:1860
bool highPriority
是否是高优先级消息
Definition: v2_nim_def_struct.hpp:1864
bool historyEnabled
是否需要在服务端保存历史消息
Definition: v2_nim_def_struct.hpp:1862
Definition: v2_nim_def_struct.hpp:1867
nstd::string text
消息内容
Definition: v2_nim_def_struct.hpp:1889
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:1897
V2NIMMessageSendingState sendingState
消息发送状态
Definition: v2_nim_def_struct.hpp:1883
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition: v2_nim_def_struct.hpp:1893
V2NIMMessageType messageType
消息类型
Definition: v2_nim_def_struct.hpp:1885
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:1899
uint32_t subType
消息子类型
Definition: v2_nim_def_struct.hpp:1887
V2NIMLoginClientType senderClientType
消息发送方客户端类型
Definition: v2_nim_def_struct.hpp:1871
V2NIMMessageAttachmentUploadState attachmentUploadState
附件上传状态
Definition: v2_nim_def_struct.hpp:1881
V2NIMChatroomMessageConfig messageConfig
聊天室消息配置
Definition: v2_nim_def_struct.hpp:1903
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition: v2_nim_def_struct.hpp:1891
nstd::string notifyTargetTags
消息的目标标签表达式
Definition: v2_nim_def_struct.hpp:1901
nstd::string messageClientId
客户端消息 ID
Definition: v2_nim_def_struct.hpp:1869
nstd::string roomId
聊天室 ID
Definition: v2_nim_def_struct.hpp:1877
bool isSelf
消息发送者是否是自己
Definition: v2_nim_def_struct.hpp:1879
V2NIMUserInfoConfig userInfoConfig
消息发送时的用户信息
Definition: v2_nim_def_struct.hpp:1905
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition: v2_nim_def_struct.hpp:1895
nstd::string senderId
消息发送者账号
Definition: v2_nim_def_struct.hpp:1875
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition: v2_nim_def_struct.hpp:1907
uint64_t createTime
消息时间, 单位毫秒
Definition: v2_nim_def_struct.hpp:1873
Definition: v2_nim_def_struct.hpp:1962
uint32_t limit
查询数量
Definition: v2_nim_def_struct.hpp:1970
V2NIMQueryDirection direction
消息查询方向
Definition: v2_nim_def_struct.hpp:1964
uint64_t beginTime
开始时间
Definition: v2_nim_def_struct.hpp:1968
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition: v2_nim_def_struct.hpp:1966
Definition: v2_nim_def_struct.hpp:389
uint64_t messageTime
消息撤回时间
Definition: v2_nim_def_struct.hpp:394
nstd::string messageClientId
消息撤回 ID
Definition: v2_nim_def_struct.hpp:392
V2NIMChatroomMessageRevokeNotificationAttachment()
Definition: v2_nim_def_struct.hpp:390
Definition: v2_nim_def_struct.hpp:364
nstd::string operatorId
操作者
Definition: v2_nim_def_struct.hpp:375
V2NIMChatroomNotificationAttachment()
Definition: v2_nim_def_struct.hpp:365
nstd::optional< V2NIMChatroomMember > chatroomMember
Definition: v2_nim_def_struct.hpp:385
nstd::vector< nstd::string > targetNicks
被操作成员的昵称列表
Definition: v2_nim_def_struct.hpp:371
nstd::vector< nstd::string > tags
更新后的标签
Definition: v2_nim_def_struct.hpp:381
nstd::optional< nstd::string > targetTag
被操作的标签
Definition: v2_nim_def_struct.hpp:373
nstd::string operatorNick
操作者昵称
Definition: v2_nim_def_struct.hpp:377
nstd::optional< nstd::string > notificationExtension
扩展字段
Definition: v2_nim_def_struct.hpp:379
nstd::vector< nstd::string > targetIds
被操作的成员账号列表
Definition: v2_nim_def_struct.hpp:369
V2NIMChatroomMessageNotificationType type
通知类型
Definition: v2_nim_def_struct.hpp:367
nstd::optional< V2NIMChatroomUpdateParams > chatroomUpdateParams
Definition: v2_nim_def_struct.hpp:383
聊天室队列元素
Definition: v2_nim_def_struct.hpp:254
nstd::string value
元素的值
Definition: v2_nim_def_struct.hpp:258
nstd::string key
元素的唯一 key,中文不建议超过 64 个字符,英文不建议超过 128 个字符
Definition: v2_nim_def_struct.hpp:256
nstd::optional< nstd::string > nick
该元素所属于的账号的昵称
Definition: v2_nim_def_struct.hpp:262
nstd::optional< nstd::string > extension
其他的扩展字段 JSON String
Definition: v2_nim_def_struct.hpp:264
nstd::optional< nstd::string > accountId
该元素所属于的账号
Definition: v2_nim_def_struct.hpp:260
Definition: v2_nim_def_struct.hpp:398
nstd::vector< V2NIMChatroomQueueElement > elements
队列变更的内容
Definition: v2_nim_def_struct.hpp:401
V2NIMChatroomQueueNotificationAttachment()
Definition: v2_nim_def_struct.hpp:399
V2NIMChatroomQueueChangeType queueChangeType
队列更新类型
Definition: v2_nim_def_struct.hpp:403
Definition: v2_nim_def_struct.hpp:2064
bool transient
元素是否瞬态的
Definition: v2_nim_def_struct.hpp:2070
nstd::optional< nstd::string > elementOwnerAccountId
元素属于的账号
Definition: v2_nim_def_struct.hpp:2072
nstd::string elementValue
元素的值
Definition: v2_nim_def_struct.hpp:2068
nstd::string elementKey
元素的唯一key
Definition: v2_nim_def_struct.hpp:2066
Definition: v2_nim_def_struct.hpp:1982
bool persistence
更新信息持久化
Definition: v2_nim_def_struct.hpp:1994
nstd::optional< nstd::string > roomNick
聊天室显示的昵称
Definition: v2_nim_def_struct.hpp:1984
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition: v2_nim_def_struct.hpp:1992
nstd::optional< nstd::string > roomAvatar
聊天室显示的头像
Definition: v2_nim_def_struct.hpp:1986
nstd::optional< nstd::string > serverExtension
成员扩展字段
Definition: v2_nim_def_struct.hpp:1988
bool notificationEnabled
是否需要通知
Definition: v2_nim_def_struct.hpp:1990
Definition: v2_nim_def_struct.hpp:1750
nstd::vector< nstd::string > tags
登陆标签
Definition: v2_nim_def_struct.hpp:1752
nstd::string notifyTargetTags
登录登出通知标签
Definition: v2_nim_def_struct.hpp:1754
Definition: v2_nim_def_struct.hpp:2021
nstd::string tag
标签
Definition: v2_nim_def_struct.hpp:2023
uint32_t limit
查询条数
Definition: v2_nim_def_struct.hpp:2027
nstd::string pageToken
偏移量
Definition: v2_nim_def_struct.hpp:2025
Definition: v2_nim_def_struct.hpp:2030
nstd::vector< V2NIMMessageType > messageTypes
消息类型
Definition: v2_nim_def_struct.hpp:2034
V2NIMQueryDirection direction
查询方向
Definition: v2_nim_def_struct.hpp:2042
uint32_t limit
查询条数
Definition: v2_nim_def_struct.hpp:2040
uint64_t beginTime
查询起始时间
Definition: v2_nim_def_struct.hpp:2036
nstd::vector< nstd::string > tags
查询的标签
Definition: v2_nim_def_struct.hpp:2032
uint64_t endTime
查询结束时间
Definition: v2_nim_def_struct.hpp:2038
Definition: v2_nim_def_struct.hpp:1997
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition: v2_nim_def_struct.hpp:2007
bool notificationEnabled
是否需要通知
Definition: v2_nim_def_struct.hpp:2005
uint64_t duration
禁言时长, 单位秒
Definition: v2_nim_def_struct.hpp:2003
nstd::string notifyTargetTags
消息的目标标签表达式
Definition: v2_nim_def_struct.hpp:2001
nstd::string targetTag
禁言的 tag
Definition: v2_nim_def_struct.hpp:1999
Definition: v2_nim_def_struct.hpp:2010
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition: v2_nim_def_struct.hpp:2018
nstd::optional< nstd::string > notifyTargetTags
消息的目标标签表达式
Definition: v2_nim_def_struct.hpp:2014
bool notificationEnabled
是否需要通知
Definition: v2_nim_def_struct.hpp:2016
nstd::optional< nstd::vector< nstd::string > > tags
标签
Definition: v2_nim_def_struct.hpp:2012
Definition: v2_nim_def_struct.hpp:195
bool notificationEnabled
是否需要通知
Definition: v2_nim_def_struct.hpp:205
nstd::optional< nstd::string > roomName
聊天室名称
Definition: v2_nim_def_struct.hpp:197
nstd::string notificationExtension
本次操作生成的通知中的扩展字段
Definition: v2_nim_def_struct.hpp:207
nstd::optional< nstd::string > serverExtension
聊天室扩展字段
Definition: v2_nim_def_struct.hpp:203
nstd::optional< V2NIMChatroomQueueLevelMode > queueLevelMode
Definition: v2_nim_def_struct.hpp:209
nstd::optional< nstd::string > announcement
聊天室公告
Definition: v2_nim_def_struct.hpp:199
nstd::optional< nstd::string > liveUrl
聊天室直播地址
Definition: v2_nim_def_struct.hpp:201
Definition: v2_nim_def_struct.hpp:1009
bool deleteRoam
是否同步删除漫游消息, 默认删除, 该字段只 P2P 时有效
Definition: v2_nim_def_struct.hpp:1013
bool onlineSync
是否多端同步, 默认不同步
Definition: v2_nim_def_struct.hpp:1015
nstd::optional< nstd::string > serverExtension
扩展字段, 多端同步时会同步到其它端
Definition: v2_nim_def_struct.hpp:1017
nstd::string conversationId
需要清空消息的对应的会话 ID
Definition: v2_nim_def_struct.hpp:1011
Definition: v2_nim_def_struct.hpp:1062
uint64_t deleteTime
被删除的时间
Definition: v2_nim_def_struct.hpp:1066
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:1064
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition: v2_nim_def_struct.hpp:1068
Definition: v2_nim_def_struct.hpp:921
V2NIMClientAntispamOperateType operateType
客户端反垃圾文本命中后操作类型
Definition: v2_nim_def_struct.hpp:923
nstd::string replacedText
处理后的文本内容
Definition: v2_nim_def_struct.hpp:925
Definition: v2_nim_def_struct.hpp:2058
std::string config
Definition: v2_nim_def_struct.hpp:2060
std::string name
Definition: v2_nim_def_struct.hpp:2059
std::vector< V2NIMClientAntispamThesaurusItem > items
Definition: v2_nim_def_struct.hpp:2061
Definition: v2_nim_def_struct.hpp:2051
std::string config
Definition: v2_nim_def_struct.hpp:2055
V2NIMClientAntispamThesaurusMatchType matchType
Definition: v2_nim_def_struct.hpp:2053
std::string key
Definition: v2_nim_def_struct.hpp:2052
V2NIMClientAntispamOperateType operateType
Definition: v2_nim_def_struct.hpp:2054
Definition: v2_nim_def_struct.hpp:1071
uint32_t collectionType
收藏索引
Definition: v2_nim_def_struct.hpp:1075
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1079
nstd::optional< nstd::string > uniqueId
去重唯一 ID
Definition: v2_nim_def_struct.hpp:1081
nstd::string collectionId
收藏信息服务端 ID
Definition: v2_nim_def_struct.hpp:1073
nstd::string collectionData
收藏数据
Definition: v2_nim_def_struct.hpp:1077
uint64_t createTime
创建时间
Definition: v2_nim_def_struct.hpp:1083
uint64_t updateTime
更新时间
Definition: v2_nim_def_struct.hpp:1085
Definition: v2_nim_def_struct.hpp:1114
nstd::vector< V2NIMCollection > collectionList
本次分页查询返回的收藏列表
Definition: v2_nim_def_struct.hpp:1118
uint32_t totalCount
总收藏条数
Definition: v2_nim_def_struct.hpp:1116
Definition: v2_nim_def_struct.hpp:1099
uint64_t endTime
查询结束时间区间, 闭区间, 0 表示当前时间
Definition: v2_nim_def_struct.hpp:1103
nstd::optional< V2NIMCollection > anchorCollection
查询锚点
Definition: v2_nim_def_struct.hpp:1105
V2NIMQueryDirection direction
查询方向
Definition: v2_nim_def_struct.hpp:1107
uint32_t limit
每次查询收藏条数
Definition: v2_nim_def_struct.hpp:1109
uint64_t beginTime
查询开始时间区间, 闭区间
Definition: v2_nim_def_struct.hpp:1101
uint32_t collectionType
收藏类型
Definition: v2_nim_def_struct.hpp:1111
Definition: v2_nim_def_struct.hpp:1291
bool ignoreMuted
过滤免打扰会话
Definition: v2_nim_def_struct.hpp:1297
nstd::string conversationGroupId
过滤指定分组的会话, nullopt: 不过滤会话分组
Definition: v2_nim_def_struct.hpp:1295
nstd::set< V2NIMConversationType > conversationTypes
过滤指定对话类型, empty: 不限制会话类型
Definition: v2_nim_def_struct.hpp:1293
Definition: v2_nim_def_struct.hpp:1300
uint64_t updateTime
更新时间
Definition: v2_nim_def_struct.hpp:1310
nstd::string name
会话分组名称
Definition: v2_nim_def_struct.hpp:1304
nstd::string groupId
会话分组 ID
Definition: v2_nim_def_struct.hpp:1302
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1306
uint64_t createTime
创建时间
Definition: v2_nim_def_struct.hpp:1308
Definition: v2_nim_def_struct.hpp:1313
nstd::vector< V2NIMConversationOperationResult > failedList
失败的会话列表
Definition: v2_nim_def_struct.hpp:1317
V2NIMConversationGroup group
会话分组信息
Definition: v2_nim_def_struct.hpp:1315
Definition: v2_nim_def_struct.hpp:1230
nstd::optional< nstd::string > localExtension
本地扩展信息
Definition: v2_nim_def_struct.hpp:1246
nstd::vector< nstd::string > groupIds
会话分组 ID 列表
Definition: v2_nim_def_struct.hpp:1244
V2NIMConversationType type
会话类型
Definition: v2_nim_def_struct.hpp:1234
uint64_t updateTime
会话更新时间
Definition: v2_nim_def_struct.hpp:1258
nstd::optional< nstd::string > name
会话名称
Definition: v2_nim_def_struct.hpp:1236
uint64_t sortOrder
会话排序时间
Definition: v2_nim_def_struct.hpp:1254
uint64_t createTime
会话创建时间
Definition: v2_nim_def_struct.hpp:1256
nstd::optional< V2NIMLastMessage > lastMessage
最后一条消息
Definition: v2_nim_def_struct.hpp:1250
nstd::optional< nstd::string > serverExtension
服务端扩展信息
Definition: v2_nim_def_struct.hpp:1248
nstd::string conversationId
会话标识
Definition: v2_nim_def_struct.hpp:1232
uint32_t unreadCount
未读计数
Definition: v2_nim_def_struct.hpp:1252
nstd::optional< nstd::string > avatar
会话头像
Definition: v2_nim_def_struct.hpp:1238
bool stickTop
置顶
Definition: v2_nim_def_struct.hpp:1242
bool mute
免打扰
Definition: v2_nim_def_struct.hpp:1240
Definition: v2_nim_def_struct.hpp:1270
nstd::string conversationId
会话标识
Definition: v2_nim_def_struct.hpp:1272
V2NIMError error
错误
Definition: v2_nim_def_struct.hpp:1274
Definition: v2_nim_def_struct.hpp:1282
bool onlyUnread
false: 查询所有会话, true: 查询包含未读的会话
Definition: v2_nim_def_struct.hpp:1288
nstd::vector< V2NIMConversationType > conversationTypes
查询指定会话类型, empty: 不限制会话类型
Definition: v2_nim_def_struct.hpp:1284
nstd::optional< nstd::vector< nstd::string > > conversationGroupIds
查询指定分组的会话, null: 查询所有分组, empty: 查询未分组的会话
Definition: v2_nim_def_struct.hpp:1286
Definition: v2_nim_def_struct.hpp:1261
bool finished
数据是否拉取完毕
Definition: v2_nim_def_struct.hpp:1265
uint64_t offset
下一次拉取的偏移
Definition: v2_nim_def_struct.hpp:1263
nstd::vector< V2NIMConversation > conversationList
会话列表
Definition: v2_nim_def_struct.hpp:1267
Definition: v2_nim_def_struct.hpp:1277
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:1279
Definition: v2_nim_def_struct.hpp:1464
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition: v2_nim_def_struct.hpp:1488
nstd::optional< nstd::string > announcement
群组公告
Definition: v2_nim_def_struct.hpp:1474
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition: v2_nim_def_struct.hpp:1486
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition: v2_nim_def_struct.hpp:1480
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition: v2_nim_def_struct.hpp:1470
nstd::optional< nstd::string > avatar
群组头像
Definition: v2_nim_def_struct.hpp:1476
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition: v2_nim_def_struct.hpp:1484
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition: v2_nim_def_struct.hpp:1482
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1468
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition: v2_nim_def_struct.hpp:1490
nstd::optional< nstd::string > intro
群组介绍
Definition: v2_nim_def_struct.hpp:1472
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:1478
nstd::string name
群组名称
Definition: v2_nim_def_struct.hpp:1466
Definition: v2_nim_def_struct.hpp:1506
V2NIMTeam team
被创建的群组信息
Definition: v2_nim_def_struct.hpp:1508
nstd::vector< nstd::string > failedList
被邀请成员失败列表
Definition: v2_nim_def_struct.hpp:1510
Definition: v2_nim_def_struct.hpp:749
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:765
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:767
nstd::string receiverId
通知接收者账号
Definition: v2_nim_def_struct.hpp:753
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition: v2_nim_def_struct.hpp:763
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition: v2_nim_def_struct.hpp:761
nstd::string senderId
通知发送者账号
Definition: v2_nim_def_struct.hpp:751
uint64_t timestamp
客户设置时间戳
Definition: v2_nim_def_struct.hpp:757
nstd::string content
通知内容
Definition: v2_nim_def_struct.hpp:759
V2NIMConversationType conversationType
通知所属会话类型
Definition: v2_nim_def_struct.hpp:755
自定义用户状态参数
Definition: v2_nim_def_struct.hpp:2395
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition: v2_nim_def_struct.hpp:2401
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 7 天
Definition: v2_nim_def_struct.hpp:2399
uint32_t statusType
自定义设置值 10000 以上,不包括 10000,10000 以内为内部预定义值。小于 10000 将返回参数错误
Definition: v2_nim_def_struct.hpp:2397
bool multiSync
用户发布状态时是否需要多端同步
Definition: v2_nim_def_struct.hpp:2405
bool onlineOnly
用户发布状态时是否只广播给在线的订阅者
Definition: v2_nim_def_struct.hpp:2403
自定义用户状态发布结果
Definition: v2_nim_def_struct.hpp:2409
nstd::string serverId
服务器针对该状态事件生成的 ID
Definition: v2_nim_def_struct.hpp:2413
time_t publishTime
用户状态发布时的时间
Definition: v2_nim_def_struct.hpp:2415
nstd::string uniqueId
发布自定义用户状态时,内部生成的唯一 ID
Definition: v2_nim_def_struct.hpp:2411
Definition: v2_nim_def_struct.hpp:1194
V2NIMDataSyncType type
数据同步类型
Definition: v2_nim_def_struct.hpp:1196
V2NIMDataSyncState state
数据同步状态
Definition: v2_nim_def_struct.hpp:1198
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:1726
bool dndOn
免打扰是否开启
Definition: v2_nim_def_struct.hpp:1730
uint32_t fromM
如果开启免打扰,开始分钟数 (Integer)
Definition: v2_nim_def_struct.hpp:1734
uint32_t toM
如果开启免打扰,截止分钟数 (Integer)
Definition: v2_nim_def_struct.hpp:1738
uint32_t toH
如果开启免打扰,截止小时数 (Integer)
Definition: v2_nim_def_struct.hpp:1736
uint32_t fromH
如果开启免打扰,开始小时数 (Integer)
Definition: v2_nim_def_struct.hpp:1732
bool showDetail
是否显示详情
Definition: v2_nim_def_struct.hpp:1728
下载消息附件资源请求参数
Definition: v2_nim_def_struct.hpp:2112
nstd::optional< nstd::string > saveAs
附件保存路径,如未指定 SDK 将下载到登录用户缓存目录,如指定该参数则以指定的路径为准
Definition: v2_nim_def_struct.hpp:2122
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件信息
Definition: v2_nim_def_struct.hpp:2114
nstd::optional< nstd::string > messageClientId
消息客户端 ID,如果指定了该参数将下载完成后的本地附件保存路径更新到消息数据库中,下一次查询时将直接返回对应的路径
Definition: v2_nim_def_struct.hpp:2120
V2NIMDownloadAttachmentType type
要下载附件的类型 V2NIMDownloadAttachmentType
Definition: v2_nim_def_struct.hpp:2116
nstd::optional< V2NIMSize > thumbSize
如果下载的是缩略图或者视频封面,通过该参数指定缩略图大小或视频封面大小
Definition: v2_nim_def_struct.hpp:2118
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
V2NIMError()=default
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:1635
nstd::optional< nstd::string > postscript
附言
Definition: v2_nim_def_struct.hpp:1643
nstd::string applicantAccountId
申请者账号
Definition: v2_nim_def_struct.hpp:1637
bool read
是否已读
Definition: v2_nim_def_struct.hpp:1649
nstd::string operatorAccountId
操作者账号
Definition: v2_nim_def_struct.hpp:1641
uint64_t timestamp
时间
Definition: v2_nim_def_struct.hpp:1647
nstd::string recipientAccountId
被申请者账号
Definition: v2_nim_def_struct.hpp:1639
V2NIMFriendAddApplicationStatus status
状态
Definition: v2_nim_def_struct.hpp:1645
Definition: v2_nim_def_struct.hpp:1708
uint64_t offset
分页偏移
Definition: v2_nim_def_struct.hpp:1710
nstd::vector< V2NIMFriendAddApplicationStatus > status
查询状态
Definition: v2_nim_def_struct.hpp:1714
uint32_t limit
查询数量
Definition: v2_nim_def_struct.hpp:1712
Definition: v2_nim_def_struct.hpp:1717
nstd::vector< V2NIMFriendAddApplication > infos
查询返回的列表
Definition: v2_nim_def_struct.hpp:1719
bool finished
分页结束
Definition: v2_nim_def_struct.hpp:1723
uint64_t offset
下一次的偏移量
Definition: v2_nim_def_struct.hpp:1721
Definition: v2_nim_def_struct.hpp:1628
V2NIMFriendAddMode addMode
添加好友模式
Definition: v2_nim_def_struct.hpp:1630
nstd::optional< nstd::string > postscript
添加/申请添加好友的附言
Definition: v2_nim_def_struct.hpp:1632
Definition: v2_nim_def_struct.hpp:1652
bool deleteAlias
是否删除备注
Definition: v2_nim_def_struct.hpp:1654
Definition: v2_nim_def_struct.hpp:1607
nstd::optional< uint64_t > createTime
创建时间
Definition: v2_nim_def_struct.hpp:1617
nstd::optional< uint32_t > flag
Definition: v2_nim_def_struct.hpp:1623
nstd::optional< nstd::string > serverExtension
好友扩展字段
Definition: v2_nim_def_struct.hpp:1613
nstd::optional< nstd::string > alias
好友备注
Definition: v2_nim_def_struct.hpp:1611
V2NIMUser userProfile
好友对应的用户信息
Definition: v2_nim_def_struct.hpp:1621
nstd::string accountId
好友账号
Definition: v2_nim_def_struct.hpp:1609
nstd::optional< uint64_t > updateTime
更新时间
Definition: v2_nim_def_struct.hpp:1619
nstd::optional< nstd::string > customerExtension
用户扩展字段
Definition: v2_nim_def_struct.hpp:1615
nstd::optional< uint32_t > beflag
Definition: v2_nim_def_struct.hpp:1625
Definition: v2_nim_def_struct.hpp:1664
bool searchAccountId
是否搜索用户账号
Definition: v2_nim_def_struct.hpp:1670
bool searchAlias
是否搜索用户昵称
Definition: v2_nim_def_struct.hpp:1668
nstd::string keyword
搜索关键字, 默认搜索好友备注, 可以指定是否同时搜索用户账号
Definition: v2_nim_def_struct.hpp:1666
Definition: v2_nim_def_struct.hpp:1657
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1661
nstd::optional< nstd::string > alias
别名
Definition: v2_nim_def_struct.hpp:1659
Definition: v2_nim_def_struct.hpp:2125
nstd::map< nstd::string, nstd::string > authHeaders
下载该资源所需的鉴权信息,当列表为空时则代表不需要鉴权,若不为空则需要将该列表添加到请求时的 Header 中
Definition: v2_nim_def_struct.hpp:2129
nstd::string url
附件资源完整下载地址
Definition: v2_nim_def_struct.hpp:2127
Definition: v2_nim_def_struct.hpp:121
V2NIMBasicOption basicOption
基础配置
Definition: v2_nim_def_struct.hpp:127
V2NIMFCSOption fcsOption
融合存储配置
Definition: v2_nim_def_struct.hpp:133
nstd::optional< V2NIMPrivateServerOption > privateServerOption
私有化配置
Definition: v2_nim_def_struct.hpp:135
V2NIMLinkOption linkOption
连接相关配置
Definition: v2_nim_def_struct.hpp:129
nstd::string appDataPath
app 数据目录, 为空则使用默认目录
Definition: v2_nim_def_struct.hpp:125
V2NIMDatabaseOption databaseOption
数据库配置
Definition: v2_nim_def_struct.hpp:131
nstd::string appkey
app key
Definition: v2_nim_def_struct.hpp:123
Definition: v2_nim_def_struct.hpp:1183
V2NIMKickedOfflineReason reason
原因
Definition: v2_nim_def_struct.hpp:1185
V2NIMLoginClientType clientType
客户端类型
Definition: v2_nim_def_struct.hpp:1189
uint32_t customClientType
自定义客户端类型
Definition: v2_nim_def_struct.hpp:1191
nstd::string reasonDesc
说明
Definition: v2_nim_def_struct.hpp:1187
Definition: v2_nim_def_struct.hpp:1201
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition: v2_nim_def_struct.hpp:1211
nstd::optional< V2NIMMessageRefer > messageRefer
最后一条消息引用
Definition: v2_nim_def_struct.hpp:1205
nstd::optional< nstd::string > callbackExtension
第三方扩展字段
Definition: v2_nim_def_struct.hpp:1227
nstd::optional< V2NIMMessageRevokeType > revokeType
消息撤回类型
Definition: v2_nim_def_struct.hpp:1219
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附件
Definition: v2_nim_def_struct.hpp:1215
nstd::optional< uint32_t > subType
消息子类型
Definition: v2_nim_def_struct.hpp:1209
nstd::optional< V2NIMMessageType > messageType
最后一条消息类型
Definition: v2_nim_def_struct.hpp:1207
nstd::optional< nstd::string > serverExtension
扩展信息
Definition: v2_nim_def_struct.hpp:1225
nstd::string text
消息文本内容或撤回附言
Definition: v2_nim_def_struct.hpp:1213
nstd::optional< nstd::string > senderId
发送者账号信息
Definition: v2_nim_def_struct.hpp:1221
nstd::optional< nstd::string > revokeAccountId
消息撤回者账号
Definition: v2_nim_def_struct.hpp:1217
nstd::optional< nstd::string > senderName
如果是正常接收的消息,则显示发送者昵称。如果是被撤回的消息,则显示消息撤回者昵称。显示规则:如果是好友,则返回好友备注,否则如果是群成员,返回群成员昵称,否则返回用户昵称
Definition: v2_nim_def_struct.hpp:1223
V2NIMLastMessageState lastMessageState
最后一条消息状态
Definition: v2_nim_def_struct.hpp:1203
Definition: v2_nim_def_struct.hpp:1757
nstd::optional< double > y
空间坐标 Y
Definition: v2_nim_def_struct.hpp:1761
nstd::optional< double > z
空间坐标 Z
Definition: v2_nim_def_struct.hpp:1763
nstd::optional< double > x
空间坐标 X
Definition: v2_nim_def_struct.hpp:1759
Definition: v2_nim_def_struct.hpp:1166
uint64_t timestamp
登录时间
Definition: v2_nim_def_struct.hpp:1172
V2NIMLoginClientType type
客户端类型
Definition: v2_nim_def_struct.hpp:1168
nstd::string clientId
客户端 ID
Definition: v2_nim_def_struct.hpp:1178
uint32_t customClientType
自定义类型
Definition: v2_nim_def_struct.hpp:1176
nstd::string customTag
自定义信息
Definition: v2_nim_def_struct.hpp:1174
nstd::string clientIP
客户端外网 IP 地址
Definition: v2_nim_def_struct.hpp:1180
nstd::string os
操作系统
Definition: v2_nim_def_struct.hpp:1170
Definition: v2_nim_def_struct.hpp:1149
uint32_t retryCount
重试次数
Definition: v2_nim_def_struct.hpp:1151
V2NIMLoginExtensionProvider loginExtensionProvider
登陆扩展信息获取回调
Definition: v2_nim_def_struct.hpp:1161
bool forceMode
强制登录模式
Definition: v2_nim_def_struct.hpp:1155
V2NIMDataSyncLevel syncLevel
数据同步等级
Definition: v2_nim_def_struct.hpp:1163
V2NIMLoginAuthType authType
认证类型
Definition: v2_nim_def_struct.hpp:1157
uint64_t timeout
登录超时, 单位毫秒
Definition: v2_nim_def_struct.hpp:1153
V2NIMTokenProvider tokenProvider
动态 token 获取回调
Definition: v2_nim_def_struct.hpp:1159
Definition: v2_nim_def_struct.hpp:625
V2NIMMessageAIStatus aiStatus
缺省表示普通消息
Definition: v2_nim_def_struct.hpp:629
nstd::string accountId
数字人账号信息
Definition: v2_nim_def_struct.hpp:627
Definition: v2_nim_def_struct.hpp:632
nstd::string accountId
数字人账号信息
Definition: v2_nim_def_struct.hpp:634
nstd::optional< V2NIMAIModelCallContent > content
请求大模型的内容
Definition: v2_nim_def_struct.hpp:636
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition: v2_nim_def_struct.hpp:640
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition: v2_nim_def_struct.hpp:638
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空, 则默认覆盖控制相关配置
Definition: v2_nim_def_struct.hpp:642
Definition: v2_nim_def_struct.hpp:817
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换
Definition: v2_nim_def_struct.hpp:825
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition: v2_nim_def_struct.hpp:827
V2NIMAIModelCallContent aiModelCallParams
请求大模型的内容
Definition: v2_nim_def_struct.hpp:821
nstd::optional< nstd::vector< V2NIMMessage > > messages
上下文内容
Definition: v2_nim_def_struct.hpp:823
nstd::string accountId
AI 代理人的账号
Definition: v2_nim_def_struct.hpp:819
Definition: v2_nim_def_struct.hpp:471
nstd::optional< nstd::string > antispamExtension
易盾反垃圾(增强检测数据), json格式, 限制长度 1024 字节
Definition: v2_nim_def_struct.hpp:483
bool antispamEnabled
指定是否需要过安全通
Definition: v2_nim_def_struct.hpp:473
nstd::optional< nstd::string > antispamCustomMessage
Definition: v2_nim_def_struct.hpp:479
nstd::optional< nstd::string > antispamCheating
易盾反作弊(辅助检测数据), json格式, 限制长度 1024 字节
Definition: v2_nim_def_struct.hpp:481
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id, 而不使用云信后台配置的
Definition: v2_nim_def_struct.hpp:475
Definition: v2_nim_def_struct.hpp:268
nstd::string raw
附件内容
Definition: v2_nim_def_struct.hpp:270
V2NIMMessageAttachmentType attachmentType
Definition: v2_nim_def_struct.hpp:272
virtual ~V2NIMMessageAttachment()=default
Definition: v2_nim_def_struct.hpp:307
uint32_t duration
语音文件播放时长
Definition: v2_nim_def_struct.hpp:310
V2NIMMessageAudioAttachment()
Definition: v2_nim_def_struct.hpp:308
Definition: v2_nim_def_struct.hpp:336
int32_t status
通话状态,业务自定义状态
Definition: v2_nim_def_struct.hpp:343
nstd::string channelId
话单频道 ID
Definition: v2_nim_def_struct.hpp:341
V2NIMMessageCallAttachment()
Definition: v2_nim_def_struct.hpp:337
nstd::vector< V2NIMMessageCallDuration > durations
通话成员时长列表
Definition: v2_nim_def_struct.hpp:345
int32_t type
话单类型, 业务自定义
Definition: v2_nim_def_struct.hpp:339
话单消息通话时长描述信息
Definition: v2_nim_def_struct.hpp:246
uint32_t duration
通话时长, 单位秒
Definition: v2_nim_def_struct.hpp:250
nstd::string accountId
话单对应成员的账号 ID
Definition: v2_nim_def_struct.hpp:248
Definition: v2_nim_def_struct.hpp:979
nstd::string replaceContent
处理后的文本内容
Definition: v2_nim_def_struct.hpp:983
V2NIMMessageClientAntispamOperatorType operateType
客户端反垃圾文本命中后操作类型
Definition: v2_nim_def_struct.hpp:981
Definition: v2_nim_def_struct.hpp:520
bool readReceiptEnabled
是否需要消息已读回执信息
Definition: v2_nim_def_struct.hpp:522
bool lastMessageUpdateEnabled
是否需要更新消息所属的会话信息
Definition: v2_nim_def_struct.hpp:524
bool historyEnabled
是否需要存历史消息
Definition: v2_nim_def_struct.hpp:526
bool onlineSyncEnabled
是否需要发送方多端在线同步消息
Definition: v2_nim_def_struct.hpp:530
bool unreadEnabled
是否需要计未读
Definition: v2_nim_def_struct.hpp:534
bool offlineEnabled
是否需要存离线消息
Definition: v2_nim_def_struct.hpp:532
bool roamingEnabled
是否需要存漫游消息
Definition: v2_nim_def_struct.hpp:528
自定义消息附件
Definition: v2_nim_def_struct.hpp:2449
virtual void parse(const nstd::string &attach)=0
V2NIMMessageCustomAttachment()
Definition: v2_nim_def_struct.hpp:2450
自定义消息附件解析器
Definition: v2_nim_def_struct.hpp:2455
virtual ~V2NIMMessageCustomAttachmentParser()=default
virtual nstd::shared_ptr< V2NIMMessageAttachment > parse(const nstd::string &attach, const int32_t &subType)=0
Definition: v2_nim_def_struct.hpp:1053
nstd::optional< nstd::string > serverExtension
被删除时填入的扩展字段
Definition: v2_nim_def_struct.hpp:1059
uint64_t deleteTime
被删除的时间
Definition: v2_nim_def_struct.hpp:1057
V2NIMMessageRefer messageRefer
被删除的消息引用
Definition: v2_nim_def_struct.hpp:1055
Definition: v2_nim_def_struct.hpp:277
nstd::string path
文件本地路径
Definition: v2_nim_def_struct.hpp:288
nstd::string ext
文件扩展名
Definition: v2_nim_def_struct.hpp:290
nstd::string name
文件显示名称
Definition: v2_nim_def_struct.hpp:286
V2NIMMessageFileAttachment()
Definition: v2_nim_def_struct.hpp:278
nstd::string url
文件 url
Definition: v2_nim_def_struct.hpp:284
V2NIMMessageAttachmentUploadState uploadState
附件上传状态
Definition: v2_nim_def_struct.hpp:294
nstd::string sceneName
文件存储场景
Definition: v2_nim_def_struct.hpp:292
nstd::string md5
文件 md5
Definition: v2_nim_def_struct.hpp:282
uint64_t size
文件大小
Definition: v2_nim_def_struct.hpp:280
Definition: v2_nim_def_struct.hpp:645
bool isSelf
消息发送者是否是自己
Definition: v2_nim_def_struct.hpp:697
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition: v2_nim_def_struct.hpp:685
nstd::optional< nstd::string > localExtension
本地扩展
Definition: v2_nim_def_struct.hpp:673
uint64_t createTime
消息时间
Definition: v2_nim_def_struct.hpp:651
nstd::string conversationId
消息所属会话 ID
Definition: v2_nim_def_struct.hpp:661
nstd::optional< uint64_t > modifyTime
消息更新时间
Definition: v2_nim_def_struct.hpp:701
nstd::optional< V2NIMMessageRefer > threadReply
回复消息引用
Definition: v2_nim_def_struct.hpp:695
V2NIMMessageConfig messageConfig
消息相关配置
Definition: v2_nim_def_struct.hpp:683
nstd::string receiverId
消息接收者账号
Definition: v2_nim_def_struct.hpp:657
V2NIMConversationType conversationType
消息所属会话类型
Definition: v2_nim_def_struct.hpp:659
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:689
nstd::optional< nstd::string > serverExtension
服务端扩展
Definition: v2_nim_def_struct.hpp:671
nstd::optional< V2NIMMessageAIConfig > aiConfig
AI 数字人相关信息
Definition: v2_nim_def_struct.hpp:699
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:687
nstd::string senderId
消息发送者账号
Definition: v2_nim_def_struct.hpp:653
nstd::optional< nstd::string > callbackExtension
回调扩展
Definition: v2_nim_def_struct.hpp:675
nstd::string senderName
消息发送者发送该消息时那一刻的昵称
Definition: v2_nim_def_struct.hpp:655
nstd::optional< V2NIMMessageRefer > threadRoot
Thread 消息引用
Definition: v2_nim_def_struct.hpp:693
uint32_t subType
消息内容
Definition: v2_nim_def_struct.hpp:665
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition: v2_nim_def_struct.hpp:669
nstd::string messageServerId
服务端消息 ID
Definition: v2_nim_def_struct.hpp:649
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition: v2_nim_def_struct.hpp:691
nstd::optional< V2NIMMessageSendingState > sendingState
消息发送状态
Definition: v2_nim_def_struct.hpp:677
V2NIMMessageStatus messageStatus
消息状态
Definition: v2_nim_def_struct.hpp:681
nstd::optional< nstd::string > modifyAccountId
消息更新者账号
Definition: v2_nim_def_struct.hpp:703
V2NIMMessageType messageType
消息类型
Definition: v2_nim_def_struct.hpp:663
nstd::string messageClientId
客户端消息 ID
Definition: v2_nim_def_struct.hpp:647
nstd::string text
消息文本
Definition: v2_nim_def_struct.hpp:667
nstd::optional< V2NIMMessageAttachmentUploadState > attachmentUploadState
附件上传状态
Definition: v2_nim_def_struct.hpp:679
Definition: v2_nim_def_struct.hpp:298
uint32_t width
图片宽度
Definition: v2_nim_def_struct.hpp:301
uint32_t height
图片高度
Definition: v2_nim_def_struct.hpp:303
V2NIMMessageImageAttachment()
Definition: v2_nim_def_struct.hpp:299
Definition: v2_nim_def_struct.hpp:986
V2NIMQueryDirection direction
消息查询方向
Definition: v2_nim_def_struct.hpp:1002
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:990
uint64_t endTime
消息查询结束时间, 闭区间
Definition: v2_nim_def_struct.hpp:994
uint32_t limit
查询条数
Definition: v2_nim_def_struct.hpp:996
bool reverse
是否反向排序
Definition: v2_nim_def_struct.hpp:1000
nstd::optional< V2NIMMessage > anchorMessage
锚点消息, 根据锚点消息查询, 不包含该消息
Definition: v2_nim_def_struct.hpp:998
bool onlyQueryLocal
是否只查询本地消息
Definition: v2_nim_def_struct.hpp:1006
nstd::vector< V2NIMMessageType > messageTypes
根据消息类型查询会话, 为空表示查询所有消息类型
Definition: v2_nim_def_struct.hpp:988
uint64_t beginTime
消息查询开始时间, 闭区间
Definition: v2_nim_def_struct.hpp:992
bool strictMode
严格模式, 无法确定消息完整性则返回错误
Definition: v2_nim_def_struct.hpp:1004
Definition: v2_nim_def_struct.hpp:325
nstd::string address
详细位置信息
Definition: v2_nim_def_struct.hpp:332
double longitude
经度
Definition: v2_nim_def_struct.hpp:330
double latitude
纬度
Definition: v2_nim_def_struct.hpp:328
V2NIMMessageLocationAttachment()
Definition: v2_nim_def_struct.hpp:326
Definition: v2_nim_def_struct.hpp:890
V2NIMMessageRefer messageRefer
pin 消息引用
Definition: v2_nim_def_struct.hpp:892
uint64_t updateTime
更新时间
Definition: v2_nim_def_struct.hpp:900
nstd::string operatorId
操作者 ID
Definition: v2_nim_def_struct.hpp:894
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:896
uint64_t createTime
创建时间
Definition: v2_nim_def_struct.hpp:898
Definition: v2_nim_def_struct.hpp:903
V2NIMMessagePin pin
消息相关的PIN信息
Definition: v2_nim_def_struct.hpp:907
V2NIMMessagePinState pinState
消息 PIN 状态
Definition: v2_nim_def_struct.hpp:905
Definition: v2_nim_def_struct.hpp:437
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition: v2_nim_def_struct.hpp:441
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition: v2_nim_def_struct.hpp:451
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition: v2_nim_def_struct.hpp:447
nstd::string pushPayload
推送数据
Definition: v2_nim_def_struct.hpp:445
nstd::string pushContent
推送文本
Definition: v2_nim_def_struct.hpp:443
bool pushEnabled
是否需要推送消息
Definition: v2_nim_def_struct.hpp:439
nstd::string forcePushContent
强制推送文案
Definition: v2_nim_def_struct.hpp:449
Definition: v2_nim_def_struct.hpp:578
uint64_t begin
起始时间
Definition: v2_nim_def_struct.hpp:580
bool includeEnd
包含结束时间
Definition: v2_nim_def_struct.hpp:586
uint64_t end
结束时间
Definition: v2_nim_def_struct.hpp:582
bool includeBegin
包含起始时间
Definition: v2_nim_def_struct.hpp:584
Definition: v2_nim_def_struct.hpp:1033
uint64_t index
评论索引
Definition: v2_nim_def_struct.hpp:1039
V2NIMMessageRefer messageRefer
消息引用
Definition: v2_nim_def_struct.hpp:1035
nstd::string operatorId
操作者 ID
Definition: v2_nim_def_struct.hpp:1037
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:1041
nstd::optional< uint64_t > createTime
创建时间
Definition: v2_nim_def_struct.hpp:1043
Definition: v2_nim_def_struct.hpp:1046
V2NIMMessageQuickComment quickComment
快捷评论
Definition: v2_nim_def_struct.hpp:1050
V2NIMMessageQuickCommentType operationType
快捷评论操作类型
Definition: v2_nim_def_struct.hpp:1048
Definition: v2_nim_def_struct.hpp:1020
nstd::string pushTitle
推送标题
Definition: v2_nim_def_struct.hpp:1026
nstd::string pushPayload
推送自定义字段
Definition: v2_nim_def_struct.hpp:1030
bool needBadge
是否需要角标
Definition: v2_nim_def_struct.hpp:1024
bool needPush
是否需要推送
Definition: v2_nim_def_struct.hpp:1022
nstd::string pushContent
推送内容
Definition: v2_nim_def_struct.hpp:1028
Definition: v2_nim_def_struct.hpp:546
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:558
nstd::string receiverId
接收方账号
Definition: v2_nim_def_struct.hpp:550
nstd::string senderId
发送方账号
Definition: v2_nim_def_struct.hpp:548
nstd::string messageServerId
服务端消息 id
Definition: v2_nim_def_struct.hpp:554
uint64_t createTime
消息时间
Definition: v2_nim_def_struct.hpp:560
V2NIMConversationType conversationType
会话类型
Definition: v2_nim_def_struct.hpp:556
nstd::string messageClientId
客户端消息 id
Definition: v2_nim_def_struct.hpp:552
Definition: v2_nim_def_struct.hpp:875
V2NIMMessageRefer messageRefer
被撤回的消息引用
Definition: v2_nim_def_struct.hpp:877
nstd::string revokeAccountId
消息撤回者账号
Definition: v2_nim_def_struct.hpp:883
nstd::optional< nstd::string > postscript
附言
Definition: v2_nim_def_struct.hpp:881
nstd::optional< nstd::string > callbackExtension
第三方回调传入的自定义扩展字段
Definition: v2_nim_def_struct.hpp:887
V2NIMMessageRevokeType revokeType
消息撤回类型
Definition: v2_nim_def_struct.hpp:885
nstd::optional< nstd::string > serverExtension
扩展信息
Definition: v2_nim_def_struct.hpp:879
Definition: v2_nim_def_struct.hpp:862
nstd::optional< nstd::string > env
路由抄送地址
Definition: v2_nim_def_struct.hpp:872
nstd::optional< nstd::string > pushPayload
推送数据
Definition: v2_nim_def_struct.hpp:870
nstd::optional< nstd::string > serverExtension
扩展信息
Definition: v2_nim_def_struct.hpp:866
nstd::optional< nstd::string > pushContent
推送文案
Definition: v2_nim_def_struct.hpp:868
nstd::optional< nstd::string > postscript
附言
Definition: v2_nim_def_struct.hpp:864
Definition: v2_nim_def_struct.hpp:495
nstd::optional< nstd::string > function
机器人具体功能, 用户可以自定义输入
Definition: v2_nim_def_struct.hpp:501
nstd::optional< nstd::string > customContent
机器人自定义内容
Definition: v2_nim_def_struct.hpp:503
nstd::optional< nstd::string > accountId
机器人账号, 仅群聊有效
Definition: v2_nim_def_struct.hpp:497
nstd::optional< nstd::string > topic
机器人消息话题
Definition: v2_nim_def_struct.hpp:499
Definition: v2_nim_def_struct.hpp:506
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition: v2_nim_def_struct.hpp:510
bool routeEnabled
是否需要路由消息
Definition: v2_nim_def_struct.hpp:508
消息检索参数
Definition: v2_nim_def_struct.hpp:2493
nstd::optional< nstd::string > conversationId
要查询的会话 ID,不指定则查询所有会话
Definition: v2_nim_def_struct.hpp:2495
int64_t searchTimePeriod
从起始时间点开始的过去时间范围,默认为 0(不限制时间范围)。24 x 60 x 60 x 1000 代表过去一天,单位:毫秒
Definition: v2_nim_def_struct.hpp:2507
nstd::optional< nstd::vector< nstd::string > > senderAccountIds
匹配消息发送者,最多支持 5 个,为空则匹配所有发送者
Definition: v2_nim_def_struct.hpp:2501
V2NIMSearchKeywordMathType keywordMatchType
指定关键字列表匹配类型,见 V2NIMSearchKeywordMathType,默认为 V2NIM_SEARCH_KEYWORD_MATH_TYPE_OR
Definition: v2_nim_def_struct.hpp:2499
uint32_t limit
搜索的数量限制,默认为 20,最大为 100
Definition: v2_nim_def_struct.hpp:2509
nstd::optional< nstd::string > pageToken
下一页的 token,用于分页查询
Definition: v2_nim_def_struct.hpp:2511
nstd::optional< nstd::vector< nstd::string > > keywordList
要查询的关键字列表,为空则按发送者或消息类型查询,最多支持 5 个。当消息发送者以及消息类型均未指定时,必须设置关键字列表
Definition: v2_nim_def_struct.hpp:2497
time_t searchStartTime
搜索的起始时间点,默认为 0(从现在开始搜索)。UTC 时间戳,单位:毫秒
Definition: v2_nim_def_struct.hpp:2505
nstd::optional< nstd::vector< V2NIMMessageType > > messageTypes
匹配消息类型,为空则匹配所有类型
Definition: v2_nim_def_struct.hpp:2503
查询消息返回的结果项
Definition: v2_nim_def_struct.hpp:2515
uint32_t count
单个会话命中的数量
Definition: v2_nim_def_struct.hpp:2521
nstd::vector< V2NIMMessage > messages
返回的消息列表
Definition: v2_nim_def_struct.hpp:2519
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:2517
Definition: v2_nim_def_struct.hpp:1320
nstd::vector< V2NIMMessageType > messageTypes
要检索的消息类型, 为空表示查询所有消息类型
Definition: v2_nim_def_struct.hpp:1340
nstd::vector< nstd::string > teamIds
高级群账号列表
Definition: v2_nim_def_struct.hpp:1336
nstd::vector< nstd::string > p2pAccountIds
P2P 账号列表
Definition: v2_nim_def_struct.hpp:1334
nstd::vector< nstd::string > senderAccountIds
发送账号列表
Definition: v2_nim_def_struct.hpp:1338
uint64_t beginTime
查询起始时间
Definition: v2_nim_def_struct.hpp:1324
uint32_t messageLimit
返回消息数量
Definition: v2_nim_def_struct.hpp:1330
nstd::vector< uint32_t > messageSubTypes
要检索的消息子类型, 为空表示查询所有消息子类型
Definition: v2_nim_def_struct.hpp:1342
V2NIMSortOrder sortOrder
消息排序规则
Definition: v2_nim_def_struct.hpp:1332
nstd::string keyword
关键字
Definition: v2_nim_def_struct.hpp:1322
uint32_t conversationLimit
检索会话数量
Definition: v2_nim_def_struct.hpp:1328
uint64_t endTime
查询结束时间, 0 表示当前时间
Definition: v2_nim_def_struct.hpp:1326
查询消息返回的结果
Definition: v2_nim_def_struct.hpp:2525
nstd::vector< V2NIMMessageSearchItem > items
Definition: v2_nim_def_struct.hpp:2534
nstd::string nextPageToken
下次请求的 token,两次查询参数必须一致
Definition: v2_nim_def_struct.hpp:2536
uint32_t count
满足检索条件的所有消息数量
Definition: v2_nim_def_struct.hpp:2527
Definition: v2_nim_def_struct.hpp:589
V2NIMErrorCode errorCode
消息发送失败后的错误码信息
Definition: v2_nim_def_struct.hpp:591
bool readReceiptSent
Definition: v2_nim_def_struct.hpp:594
群组定向消息数据结构
Definition: v2_nim_def_struct.hpp:832
nstd::vector< nstd::string > receiverIds
接收者 ID 列表
Definition: v2_nim_def_struct.hpp:836
bool inclusive
为 true 时表示消息发送到群组中 receiverIds 对应的成员,为 false 时表示消息发送到群组中排除 receiverIds 以外的所有成员
Definition: v2_nim_def_struct.hpp:834
bool newMemberVisible
新成员是否可以查看该定向消息
Definition: v2_nim_def_struct.hpp:838
Definition: v2_nim_def_struct.hpp:349
V2NIMMessageNotificationType type
通知类型
Definition: v2_nim_def_struct.hpp:352
nstd::vector< nstd::string > targetIds
被操作者 ID 列表
Definition: v2_nim_def_struct.hpp:356
nstd::optional< nstd::string > serverExtension
扩展字段
Definition: v2_nim_def_struct.hpp:354
bool chatBanned
群成员是否被禁言
Definition: v2_nim_def_struct.hpp:358
V2NIMMessageTeamNotificationAttachment()
Definition: v2_nim_def_struct.hpp:350
nstd::optional< V2NIMUpdatedTeamInfo > updatedTeamInfo
群信息更新字段,有相应字段信息,则表示对应字段被修改
Definition: v2_nim_def_struct.hpp:360
Definition: v2_nim_def_struct.hpp:314
uint32_t height
图片高度
Definition: v2_nim_def_struct.hpp:321
V2NIMMessageVideoAttachment()
Definition: v2_nim_def_struct.hpp:315
uint32_t width
图片宽度
Definition: v2_nim_def_struct.hpp:319
uint32_t duration
视频文件播放时长
Definition: v2_nim_def_struct.hpp:317
Definition: v2_nim_def_struct.hpp:717
nstd::shared_ptr< V2NIMMessageAttachment > attachment
消息附属附件
Definition: v2_nim_def_struct.hpp:723
nstd::optional< V2NIMMessageRouteConfig > routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:729
nstd::optional< uint32_t > subType
消息子类型
Definition: v2_nim_def_struct.hpp:719
nstd::optional< V2NIMMessageAntispamConfig > antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:727
nstd::optional< nstd::string > text
消息内容
Definition: v2_nim_def_struct.hpp:721
nstd::optional< nstd::string > serverExtension
消息服务端扩展
Definition: v2_nim_def_struct.hpp:725
bool clientAntispamEnabled
是否启用本地反垃圾
Definition: v2_nim_def_struct.hpp:733
nstd::optional< V2NIMMessagePushConfig > pushConfig
推送相关配置
Definition: v2_nim_def_struct.hpp:731
nstd::optional< nstd::string > clientAntispamReplace
反垃圾命中后替换的文本
Definition: v2_nim_def_struct.hpp:735
Definition: v2_nim_def_struct.hpp:937
nstd::string antispamResult
云端反垃圾返回的结果
Definition: v2_nim_def_struct.hpp:943
V2NIMMessage message
修改成功后的消息体
Definition: v2_nim_def_struct.hpp:939
V2NIMClientAntispamResult clientAntispamResult
客户端本地反垃圾结果
Definition: v2_nim_def_struct.hpp:945
int32_t errorCode
返回错误码
Definition: v2_nim_def_struct.hpp:941
Definition: v2_nim_def_struct.hpp:486
nstd::optional< nstd::string > antispamCustomMessage
Definition: v2_nim_def_struct.hpp:492
bool antispamEnabled
指定是否需要过安全通
Definition: v2_nim_def_struct.hpp:488
Definition: v2_nim_def_struct.hpp:537
nstd::optional< nstd::string > clientNotificationId
外部输入标识字段,建议输入时每次串唯一,长度不超过 32 个字符
Definition: v2_nim_def_struct.hpp:543
bool offlineEnabled
是否需要存离线消息
Definition: v2_nim_def_struct.hpp:539
bool unreadEnabled
是否需要计未读
Definition: v2_nim_def_struct.hpp:541
Definition: v2_nim_def_struct.hpp:454
bool pushNickEnabled
是否需要推送消息发送者昵称
Definition: v2_nim_def_struct.hpp:458
nstd::string forcePushContent
强制推送文案
Definition: v2_nim_def_struct.hpp:466
bool pushEnabled
是否需要推送通知
Definition: v2_nim_def_struct.hpp:456
bool forcePush
是否强制推送, 忽略用户提醒相关设置
Definition: v2_nim_def_struct.hpp:464
nstd::vector< nstd::string > forcePushAccountIds
强制推送目标账号列表
Definition: v2_nim_def_struct.hpp:468
nstd::string pushPayload
推送数据
Definition: v2_nim_def_struct.hpp:462
nstd::string pushContent
推送文本
Definition: v2_nim_def_struct.hpp:460
Definition: v2_nim_def_struct.hpp:513
bool routeEnabled
是否需要路由通知
Definition: v2_nim_def_struct.hpp:515
nstd::optional< nstd::string > routeEnvironment
路由环境变量, 用于指向不同的抄送, 第三方回调等配置
Definition: v2_nim_def_struct.hpp:517
Definition: v2_nim_def_struct.hpp:972
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:974
uint64_t timestamp
最后一条已读消息时间, 比该时间早的消息都可以认为已读
Definition: v2_nim_def_struct.hpp:976
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:792
nstd::optional< nstd::string > antispamBusinessId
指定易盾业务id
Definition: v2_nim_def_struct.hpp:796
nstd::optional< bool > antispamEnabled
指定消息是否需要经过安全通。默认为 true
Definition: v2_nim_def_struct.hpp:794
AI 数字人代理请求参数
Definition: v2_nim_def_struct.hpp:800
nstd::string requestId
请求 ID
Definition: v2_nim_def_struct.hpp:804
nstd::string accountId
机器人账号 ID
Definition: v2_nim_def_struct.hpp:802
nstd::optional< nstd::string > promptVariables
提示词变量占位符替换, 如果 V2NIMAIUser 中的 modelConfig.prompt 定义了变量,则必填. 端测不校验
Definition: v2_nim_def_struct.hpp:810
nstd::optional< nstd::vector< V2NIMAIModelCallMessage > > messages
上下文内容
Definition: v2_nim_def_struct.hpp:808
V2NIMAIModelCallContent content
请求大模型的内容
Definition: v2_nim_def_struct.hpp:806
nstd::optional< V2NIMProxyAICallAntispamConfig > antispamConfig
反垃圾配置, 复用消息体里的部分反垃圾字段
Definition: v2_nim_def_struct.hpp:814
nstd::optional< V2NIMAIModelConfigParams > modelConfigParams
请求接口模型相关参数配置, 如果参数不为空,则默认覆盖控制相关配置
Definition: v2_nim_def_struct.hpp:812
代理请求回调
Definition: v2_nim_def_struct.hpp:2483
time_t time
发送时间,毫秒
Definition: v2_nim_def_struct.hpp:2489
nstd::string fromAccountId
发送方账号
Definition: v2_nim_def_struct.hpp:2485
nstd::string body
通知体
Definition: v2_nim_def_struct.hpp:2487
HTTP 代理请求参数
Definition: v2_nim_def_struct.hpp:2461
nstd::optional< nstd::string > body
请求体
Definition: v2_nim_def_struct.hpp:2471
nstd::optional< nstd::string > header
请求头
Definition: v2_nim_def_struct.hpp:2469
nstd::optional< nstd::string > zone
映射一个请求地址,不传使用服务器默认的配置
Definition: v2_nim_def_struct.hpp:2467
V2NIMProxyRequestMethod method
请求方法
Definition: v2_nim_def_struct.hpp:2465
nstd::string path
请求路径
Definition: v2_nim_def_struct.hpp:2463
HTTP 代理响应
Definition: v2_nim_def_struct.hpp:2475
nstd::string header
响应头
Definition: v2_nim_def_struct.hpp:2477
nstd::string body
响应体
Definition: v2_nim_def_struct.hpp:2479
Definition: v2_nim_def_struct.hpp:1910
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:1916
nstd::string clientAntispamReplace
反垃圾命中后替换的文本
Definition: v2_nim_def_struct.hpp:1920
nstd::vector< nstd::string > receiverIds
定向消息接收者账号列表, 为空表示不定向, 定向消息不存历史
Definition: v2_nim_def_struct.hpp:1922
V2NIMChatroomMessageConfig messageConfig
消息相关配置
Definition: v2_nim_def_struct.hpp:1912
nstd::string notifyTargetTags
消息的目标标签表达式
Definition: v2_nim_def_struct.hpp:1924
nstd::optional< V2NIMLocationInfo > locationInfo
消息空间坐标信息配置
Definition: v2_nim_def_struct.hpp:1926
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:1914
bool clientAntispamEnabled
是否启用本地反垃圾
Definition: v2_nim_def_struct.hpp:1918
Definition: v2_nim_def_struct.hpp:1929
V2NIMChatroomMessage message
发送成功后的消息体
Definition: v2_nim_def_struct.hpp:1931
nstd::string antispamResult
云端反垃圾返回的结果
Definition: v2_nim_def_struct.hpp:1933
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition: v2_nim_def_struct.hpp:1935
Definition: v2_nim_def_struct.hpp:910
V2NIMNotificationRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:918
V2NIMNotificationAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:916
V2NIMNotificationConfig notificationConfig
通知相关配置
Definition: v2_nim_def_struct.hpp:912
V2NIMNotificationPushConfig pushConfig
离线推送配置相关
Definition: v2_nim_def_struct.hpp:914
Definition: v2_nim_def_struct.hpp:841
V2NIMMessageAntispamConfig antispamConfig
反垃圾相关配置
Definition: v2_nim_def_struct.hpp:849
V2NIMMessageRobotConfig robotConfig
机器人相关配置
Definition: v2_nim_def_struct.hpp:851
V2NIMMessageRouteConfig routeConfig
路由抄送相关配置
Definition: v2_nim_def_struct.hpp:845
V2NIMMessagePushConfig pushConfig
推送相关配置
Definition: v2_nim_def_struct.hpp:847
nstd::string clientAntispamReplace
本地反垃圾命中后替换的文本
Definition: v2_nim_def_struct.hpp:855
bool clientAntispamEnabled
是否启用本地反垃圾
Definition: v2_nim_def_struct.hpp:853
nstd::optional< V2NIMMessageAIConfigParams > aiConfig
请求大模型的相关参数
Definition: v2_nim_def_struct.hpp:857
nstd::optional< V2NIMMessageTargetConfig > targetConfig
用以控制在发送群组消息时,消息是否发送给指定的群组成员
Definition: v2_nim_def_struct.hpp:859
V2NIMMessageConfig messageConfig
消息相关配置
Definition: v2_nim_def_struct.hpp:843
Definition: v2_nim_def_struct.hpp:928
nstd::optional< V2NIMClientAntispamResult > clientAntispamResult
客户端本地反垃圾结果
Definition: v2_nim_def_struct.hpp:934
V2NIMMessage message
发送成功后的消息体
Definition: v2_nim_def_struct.hpp:930
nstd::optional< nstd::string > antispamResult
反垃圾返回的结果
Definition: v2_nim_def_struct.hpp:932
拒绝别人邀请加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2327
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2329
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2333
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition: v2_nim_def_struct.hpp:2335
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition: v2_nim_def_struct.hpp:2337
nstd::string inviterAccountId
邀请者账号 ID
Definition: v2_nim_def_struct.hpp:2331
信令呼叫参数
Definition: v2_nim_def_struct.hpp:2164
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition: v2_nim_def_struct.hpp:2178
nstd::optional< nstd::string > channelName
频道名称,建议使用与业务有相关场景的名称,便于页面显示
Definition: v2_nim_def_struct.hpp:2172
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,跟频道绑定,JSON 格式
Definition: v2_nim_def_struct.hpp:2174
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition: v2_nim_def_struct.hpp:2180
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition: v2_nim_def_struct.hpp:2182
nstd::string calleeAccountId
被呼叫者账号 ID
Definition: v2_nim_def_struct.hpp:2166
V2NIMSignallingChannelType channelType
频道类型
Definition: v2_nim_def_struct.hpp:2170
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition: v2_nim_def_struct.hpp:2176
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2168
呼叫回包
Definition: v2_nim_def_struct.hpp:2235
int32_t callStatus
呼叫状态
Definition: v2_nim_def_struct.hpp:2241
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition: v2_nim_def_struct.hpp:2237
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition: v2_nim_def_struct.hpp:2239
呼叫建立请求参数,包括接收方进入频道房间相关信息,以及接受方需要的相关音视频房间信息
Definition: v2_nim_def_struct.hpp:2245
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2251
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition: v2_nim_def_struct.hpp:2255
nstd::string callerAccountId
接受的呼叫者账号 ID
Definition: v2_nim_def_struct.hpp:2249
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition: v2_nim_def_struct.hpp:2253
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2247
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition: v2_nim_def_struct.hpp:2257
接受呼叫请求回包
Definition: v2_nim_def_struct.hpp:2261
nstd::optional< V2NIMSignallingRtcInfo > rtcInfo
音视频房间相关信息
Definition: v2_nim_def_struct.hpp:2265
nstd::optional< uint32_t > callStatus
呼叫状态
Definition: v2_nim_def_struct.hpp:2267
V2NIMSignallingRoomInfo roomInfo
频道房间相关信息
Definition: v2_nim_def_struct.hpp:2263
取消之前的邀请成员加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2299
nstd::string inviteeAccountId
被邀请者账号 ID
Definition: v2_nim_def_struct.hpp:2303
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition: v2_nim_def_struct.hpp:2309
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition: v2_nim_def_struct.hpp:2307
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2301
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2305
信令频道信息
Definition: v2_nim_def_struct.hpp:2186
nstd::optional< nstd::string > channelExtension
频道相关扩展字段,长度限制 4096,JSON 格式
Definition: v2_nim_def_struct.hpp:2194
time_t createTime
频道房间创建时间
Definition: v2_nim_def_struct.hpp:2196
nstd::optional< nstd::string > channelName
信令频道名称,如果请求时不传,则该字段为空
Definition: v2_nim_def_struct.hpp:2192
nstd::string creatorAccountId
创建者账号 ID
Definition: v2_nim_def_struct.hpp:2200
nstd::string channelId
信令频道 ID,唯一标识了该频道房间,后续主要以该字段作为请求标识
Definition: v2_nim_def_struct.hpp:2188
V2NIMSignallingChannelType channelType
频道类型
Definition: v2_nim_def_struct.hpp:2190
time_t expireTime
频道房间过期时间
Definition: v2_nim_def_struct.hpp:2198
Definition: v2_nim_def_struct.hpp:2132
nstd::optional< bool > unreadEnabled
是否需要计未读
Definition: v2_nim_def_struct.hpp:2136
nstd::optional< bool > offlineEnabled
是否需要存离线消息
Definition: v2_nim_def_struct.hpp:2134
nstd::optional< int64_t > selfUid
用户 UID
Definition: v2_nim_def_struct.hpp:2138
信令事件
Definition: v2_nim_def_struct.hpp:2341
nstd::string operatorAccountId
操作者 ID
Definition: v2_nim_def_struct.hpp:2347
nstd::optional< nstd::string > inviteeAccountId
Definition: v2_nim_def_struct.hpp:2355
nstd::string requestId
Definition: v2_nim_def_struct.hpp:2365
nstd::optional< V2NIMSignallingMember > member
Definition: v2_nim_def_struct.hpp:2375
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition: v2_nim_def_struct.hpp:2349
nstd::optional< V2NIMSignallingPushConfig > pushConfig
Definition: v2_nim_def_struct.hpp:2368
nstd::optional< bool > unreadEnabled
Definition: v2_nim_def_struct.hpp:2372
nstd::optional< nstd::string > inviterAccountId
Definition: v2_nim_def_struct.hpp:2359
V2NIMSignallingChannelInfo channelInfo
信令频道房间相关信息
Definition: v2_nim_def_struct.hpp:2345
uint64_t time
操作的时间点
Definition: v2_nim_def_struct.hpp:2351
V2NIMSignallingEventType eventType
信令频道事件类型
Definition: v2_nim_def_struct.hpp:2343
邀请成员加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2283
nstd::string inviteeAccountId
被邀请者账号 ID
Definition: v2_nim_def_struct.hpp:2287
nstd::optional< V2NIMSignallingPushConfig > pushConfig
推送相关配置
Definition: v2_nim_def_struct.hpp:2295
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition: v2_nim_def_struct.hpp:2293
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096,JSON 格式
Definition: v2_nim_def_struct.hpp:2291
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2289
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2285
加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2271
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2273
nstd::optional< V2NIMSignallingConfig > signallingConfig
信令相关配置
Definition: v2_nim_def_struct.hpp:2277
nstd::optional< V2NIMSignallingRtcConfig > rtcConfig
音视频相关参数配置
Definition: v2_nim_def_struct.hpp:2279
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition: v2_nim_def_struct.hpp:2275
信令房间用户信息
Definition: v2_nim_def_struct.hpp:2204
time_t joinTime
用户加入信令频道房间时间
Definition: v2_nim_def_struct.hpp:2210
int64_t uid
成员 UID
Definition: v2_nim_def_struct.hpp:2208
time_t expireTime
用户信令频道房间过期时间
Definition: v2_nim_def_struct.hpp:2212
nstd::string deviceId
成员操作的设备 ID
Definition: v2_nim_def_struct.hpp:2214
nstd::string accountId
成员账号 ID
Definition: v2_nim_def_struct.hpp:2206
消息推送相关配置
Definition: v2_nim_def_struct.hpp:2142
nstd::optional< nstd::string > pushTitle
推送标题
Definition: v2_nim_def_struct.hpp:2146
nstd::optional< nstd::string > pushContent
推送文案
Definition: v2_nim_def_struct.hpp:2148
nstd::optional< nstd::string > pushPayload
推送数据
Definition: v2_nim_def_struct.hpp:2150
bool pushEnabled
是否需要推送
Definition: v2_nim_def_struct.hpp:2144
拒绝别人邀请加入信令房间请求参数
Definition: v2_nim_def_struct.hpp:2313
nstd::string channelId
信令频道 ID,唯一标识了该频道房间
Definition: v2_nim_def_struct.hpp:2315
nstd::optional< nstd::string > serverExtension
服务器扩展字段,长度限制 4096
Definition: v2_nim_def_struct.hpp:2321
nstd::optional< bool > offlineEnabled
是否存离线,true 表示存离线,false 表示不存离线
Definition: v2_nim_def_struct.hpp:2323
nstd::string inviterAccountId
邀请者账号 ID
Definition: v2_nim_def_struct.hpp:2317
nstd::string requestId
请求 ID,可以用 UUID 实现
Definition: v2_nim_def_struct.hpp:2319
信令房间相关信息
Definition: v2_nim_def_struct.hpp:2218
V2NIMSignallingChannelInfo channelInfo
频道房间相关信息
Definition: v2_nim_def_struct.hpp:2220
nstd::vector< V2NIMSignallingMember > members
成员列表信息
Definition: v2_nim_def_struct.hpp:2222
音视频相关配置
Definition: v2_nim_def_struct.hpp:2154
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频 SDK 相关参数,IM 信令仅透传相关参数
Definition: v2_nim_def_struct.hpp:2160
nstd::optional< nstd::string > rtcChannelName
云信音视频房间频道名称
Definition: v2_nim_def_struct.hpp:2156
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition: v2_nim_def_struct.hpp:2158
Definition: v2_nim_def_struct.hpp:2225
nstd::optional< nstd::string > rtcToken
进入音视频对应的 token
Definition: v2_nim_def_struct.hpp:2227
nstd::optional< nstd::string > rtcParams
JSON 格式字符串,音视频SDK相关参数,IM 信令仅透传相关参数
Definition: v2_nim_def_struct.hpp:2231
nstd::optional< uint32_t > rtcTokenTtl
音视频房间 token 过期时间
Definition: v2_nim_def_struct.hpp:2229
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:138
uint64_t expireTime
过期时间, 单位秒, 0 表示不过期
Definition: v2_nim_def_struct.hpp:142
nstd::string sceneName
场景名
Definition: v2_nim_def_struct.hpp:140
事件订阅选项
Definition: v2_nim_def_struct.hpp:2379
nstd::vector< nstd::string > accountIds
订阅的成员列表,为空返回参数错误,单次数量不超过 100,列表数量如果超限,默认截取前 100 个账号
Definition: v2_nim_def_struct.hpp:2381
uint32_t duration
订阅的有效期,时间范围为 60~2592000,单位:秒,过期后需要重新订阅。如果未过期的情况下重复订阅,新设置的有效期会覆盖之前的有效期
Definition: v2_nim_def_struct.hpp:2383
bool immediateSync
订阅后是否立即同步事件状态值,默认为 false,为 true 表示立即同步当前状态值。但为了性能考虑,30s 内重复订阅会忽略该参数
Definition: v2_nim_def_struct.hpp:2385
Definition: v2_nim_def_struct.hpp:1360
V2NIMTeamAgreeMode agreeMode
被邀请人入群模式, 被邀请人的同意方式
Definition: v2_nim_def_struct.hpp:1390
V2NIMTeamChatBannedMode chatBannedMode
群禁言状态
Definition: v2_nim_def_struct.hpp:1398
nstd::optional< nstd::string > intro
群组介绍
Definition: v2_nim_def_struct.hpp:1378
V2NIMTeamInviteMode inviteMode
群组邀请模式, 谁可以邀请他人入群
Definition: v2_nim_def_struct.hpp:1392
V2NIMTeamJoinMode joinMode
申请入群模式, 入群验证方式
Definition: v2_nim_def_struct.hpp:1388
V2NIMTeamUpdateExtensionMode updateExtensionMode
群组扩展字段修改模式, 谁可以修改群组扩展
Definition: v2_nim_def_struct.hpp:1396
nstd::string ownerAccountId
群组创建者/拥有者 ID
Definition: v2_nim_def_struct.hpp:1368
nstd::optional< nstd::string > announcement
群组公告
Definition: v2_nim_def_struct.hpp:1380
bool isValidTeam
是否为自己所在且有效的群, 群存在且我在群组中
Definition: v2_nim_def_struct.hpp:1400
nstd::optional< uint64_t > teamMemberTime
Definition: v2_nim_def_struct.hpp:1404
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1364
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:1384
nstd::optional< nstd::string > avatar
群组头像
Definition: v2_nim_def_struct.hpp:1382
uint64_t createTime
群组创建时间
Definition: v2_nim_def_struct.hpp:1374
nstd::string name
群组名称
Definition: v2_nim_def_struct.hpp:1366
uint32_t memberLimit
群组人数上限
Definition: v2_nim_def_struct.hpp:1370
uint32_t bits
Definition: v2_nim_def_struct.hpp:1402
V2NIMTeamUpdateInfoMode updateInfoMode
群组资料修改模式, 谁可以修改群组资料
Definition: v2_nim_def_struct.hpp:1394
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由openApi设置
Definition: v2_nim_def_struct.hpp:1386
uint64_t updateTime
群组更新时间
Definition: v2_nim_def_struct.hpp:1376
nstd::string teamId
群组ID
Definition: v2_nim_def_struct.hpp:1362
uint32_t memberCount
群组当前人数
Definition: v2_nim_def_struct.hpp:1372
Definition: v2_nim_def_struct.hpp:1529
V2NIMTeamJoinActionStatus actionStatus
操作状态
Definition: v2_nim_def_struct.hpp:1543
uint64_t timestamp
申请时间
Definition: v2_nim_def_struct.hpp:1541
V2NIMTeamJoinActionType actionType
入群操作类型
Definition: v2_nim_def_struct.hpp:1531
nstd::string teamId
群组ID
Definition: v2_nim_def_struct.hpp:1533
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1535
nstd::string operatorAccountId
申请者账号
Definition: v2_nim_def_struct.hpp:1537
nstd::optional< nstd::string > postscript
申请入群的附言
Definition: v2_nim_def_struct.hpp:1539
Definition: v2_nim_def_struct.hpp:1673
uint64_t offset
分页偏移
Definition: v2_nim_def_struct.hpp:1677
nstd::vector< V2NIMTeamJoinActionStatus > status
查询状态
Definition: v2_nim_def_struct.hpp:1681
nstd::vector< V2NIMTeamJoinActionType > types
查询类型
Definition: v2_nim_def_struct.hpp:1675
uint32_t limit
查询数量
Definition: v2_nim_def_struct.hpp:1679
Definition: v2_nim_def_struct.hpp:1699
uint64_t offset
下一次的偏移量
Definition: v2_nim_def_struct.hpp:1703
bool finished
分页结束
Definition: v2_nim_def_struct.hpp:1705
nstd::vector< V2NIMTeamJoinActionInfo > infos
查询返回的列表
Definition: v2_nim_def_struct.hpp:1701
Definition: v2_nim_def_struct.hpp:1407
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition: v2_nim_def_struct.hpp:1429
nstd::vector< nstd::string > followAccountIds
特别关注群成员 account ID 列表
Definition: v2_nim_def_struct.hpp:1431
nstd::optional< bool > inTeam
是否在群中
Definition: v2_nim_def_struct.hpp:1427
nstd::string accountId
群组成员账号
Definition: v2_nim_def_struct.hpp:1413
nstd::optional< uint64_t > joinTime
入群时间
Definition: v2_nim_def_struct.hpp:1421
nstd::optional< uint64_t > updateTime
更新时间
Definition: v2_nim_def_struct.hpp:1423
nstd::optional< uint64_t > bits
Definition: v2_nim_def_struct.hpp:1433
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1411
nstd::optional< nstd::string > teamNick
群组昵称
Definition: v2_nim_def_struct.hpp:1417
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition: v2_nim_def_struct.hpp:1425
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition: v2_nim_def_struct.hpp:1415
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:1419
nstd::string teamId
群组ID
Definition: v2_nim_def_struct.hpp:1409
Definition: v2_nim_def_struct.hpp:1520
nstd::vector< V2NIMTeamMember > memberList
拉取的成员列表
Definition: v2_nim_def_struct.hpp:1526
nstd::string nextToken
下一次查询的偏移量
Definition: v2_nim_def_struct.hpp:1524
bool finished
数据是否拉取完毕
Definition: v2_nim_def_struct.hpp:1522
Definition: v2_nim_def_struct.hpp:1493
nstd::optional< V2NIMTeamMemberRoleQueryType > roleQueryType
群成员类型
Definition: v2_nim_def_struct.hpp:1495
V2NIMQueryDirection direction
消息查询方向
Definition: v2_nim_def_struct.hpp:1499
uint32_t limit
分页拉取数量
Definition: v2_nim_def_struct.hpp:1503
bool onlyChatBanned
是否只返回聊天禁言成员列表
Definition: v2_nim_def_struct.hpp:1497
nstd::string nextToken
分页偏移, 首次传空, 后续拉取采用上一次返回的 nextToken
Definition: v2_nim_def_struct.hpp:1501
Definition: v2_nim_def_struct.hpp:1684
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1688
nstd::string nextToken
Definition: v2_nim_def_struct.hpp:1692
V2NIMSortOrder order
按照 joinTime 排序,默认时间降序排列
Definition: v2_nim_def_struct.hpp:1694
nstd::optional< nstd::string > teamId
群组ID,如果不传则检索所有群,如果需要检索特定的群,则需要同时传入 teamId + teamType
Definition: v2_nim_def_struct.hpp:1690
uint32_t limit
查询成员的个数,默认 10
Definition: v2_nim_def_struct.hpp:1696
nstd::string keyword
搜索关键词,不为空
Definition: v2_nim_def_struct.hpp:1686
Definition: v2_nim_def_struct.hpp:1437
nstd::optional< uint64_t > updateTime
更新时间
Definition: v2_nim_def_struct.hpp:1455
nstd::optional< bool > inTeam
是否在群中
Definition: v2_nim_def_struct.hpp:1459
nstd::optional< nstd::string > invitorAccountId
入群邀请人
Definition: v2_nim_def_struct.hpp:1457
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:1451
nstd::optional< bool > chatBanned
聊天是否被禁言
Definition: v2_nim_def_struct.hpp:1461
nstd::optional< nstd::string > teamNick
群组昵称
Definition: v2_nim_def_struct.hpp:1447
nstd::optional< uint64_t > joinTime
入群时间
Definition: v2_nim_def_struct.hpp:1453
nstd::optional< V2NIMTeamMemberRole > memberRole
群组成员类型
Definition: v2_nim_def_struct.hpp:1445
nstd::string accountId
群组成员账号
Definition: v2_nim_def_struct.hpp:1443
nstd::string teamId
群组ID
Definition: v2_nim_def_struct.hpp:1439
V2NIMTeamType teamType
群组类型
Definition: v2_nim_def_struct.hpp:1441
nstd::optional< uint64_t > bits
内部使用字段
Definition: v2_nim_def_struct.hpp:1449
Definition: v2_nim_def_struct.hpp:963
nstd::vector< nstd::string > readAccountList
已读账号列表
Definition: v2_nim_def_struct.hpp:967
V2NIMTeamMessageReadReceipt readReceipt
群消息已读回执
Definition: v2_nim_def_struct.hpp:965
nstd::vector< nstd::string > unreadAccountList
未读账号列表
Definition: v2_nim_def_struct.hpp:969
Definition: v2_nim_def_struct.hpp:948
nstd::optional< nstd::string > latestReadAccount
群消息最新已读账号
Definition: v2_nim_def_struct.hpp:960
uint32_t readCount
群消息已读人数
Definition: v2_nim_def_struct.hpp:956
nstd::string messageClientId
消息客户端 ID
Definition: v2_nim_def_struct.hpp:954
nstd::string conversationId
会话 ID
Definition: v2_nim_def_struct.hpp:950
uint32_t unreadCount
群消息未读人数
Definition: v2_nim_def_struct.hpp:958
nstd::string messageServerId
消息服务器 ID
Definition: v2_nim_def_struct.hpp:952
Definition: v2_nim_def_struct.hpp:563
nstd::optional< nstd::string > excludeMessageServerId
锚点消息 ServerId ,该消息必须处于端点,暨消息时间必须等于 beginTime 或 endTime
Definition: v2_nim_def_struct.hpp:571
V2NIMMessageRefer messageRefer
需要查询的消息引用,如果该消息为根消息,则参数为当前消息
Definition: v2_nim_def_struct.hpp:565
nstd::optional< uint64_t > endTime
查询结束时间
Definition: v2_nim_def_struct.hpp:569
nstd::optional< uint64_t > beginTime
查询开始时间,小于等于 endTime
Definition: v2_nim_def_struct.hpp:567
nstd::optional< V2NIMQueryDirection > direction
消息查询方向,如果其它参数都不填
Definition: v2_nim_def_struct.hpp:575
nstd::optional< uint32_t > limit
每次查询条数,默认 50
Definition: v2_nim_def_struct.hpp:573
Definition: v2_nim_def_struct.hpp:738
nstd::vector< V2NIMMessage > replyList
消息回复列表
Definition: v2_nim_def_struct.hpp:746
V2NIMMessage message
根消息
Definition: v2_nim_def_struct.hpp:740
uint32_t replyCount
获取 thread 聊天里的总回复数
Definition: v2_nim_def_struct.hpp:744
uint64_t timestamp
thread 聊天里最后一条消息的时间戳
Definition: v2_nim_def_struct.hpp:742
取消订阅选项
Definition: v2_nim_def_struct.hpp:2389
nstd::optional< nstd::vector< nstd::string > > accountIds
取消订阅的成员列表,为空则表示取消所有订阅的成员,否则取消指定的成员。单次数量不超过 100,超过默认截取前 100
Definition: v2_nim_def_struct.hpp:2391
Definition: v2_nim_def_struct.hpp:1513
nstd::optional< nstd::string > teamNick
设置的群昵称
Definition: v2_nim_def_struct.hpp:1515
nstd::optional< nstd::string > serverExtension
设置的群成员扩展字段
Definition: v2_nim_def_struct.hpp:1517
Definition: v2_nim_def_struct.hpp:212
nstd::optional< V2NIMTeamJoinMode > joinMode
申请入群模式
Definition: v2_nim_def_struct.hpp:226
nstd::optional< V2NIMTeamAgreeMode > agreeMode
被邀请人入群模式
Definition: v2_nim_def_struct.hpp:228
nstd::optional< nstd::string > avatar
群组头像
Definition: v2_nim_def_struct.hpp:222
nstd::optional< nstd::string > intro
群组介绍
Definition: v2_nim_def_struct.hpp:218
nstd::optional< V2NIMTeamUpdateExtensionMode > updateExtensionMode
群组扩展字段修改模式
Definition: v2_nim_def_struct.hpp:234
nstd::optional< V2NIMTeamInviteMode > inviteMode
群组邀请模式
Definition: v2_nim_def_struct.hpp:230
nstd::optional< uint32_t > memberLimit
群组人数上限
Definition: v2_nim_def_struct.hpp:216
nstd::optional< nstd::string > announcement
群组公告
Definition: v2_nim_def_struct.hpp:220
nstd::optional< nstd::string > name
新修改群组名称
Definition: v2_nim_def_struct.hpp:214
nstd::optional< nstd::string > serverExtension
服务端扩展字段
Definition: v2_nim_def_struct.hpp:224
nstd::optional< V2NIMTeamUpdateInfoMode > updateInfoMode
群组资料修改模式
Definition: v2_nim_def_struct.hpp:232
群组信息更新信息
Definition: v2_nim_def_struct.hpp:238
nstd::optional< nstd::string > customerExtension
客户自定义扩展, 由 openApi 设置
Definition: v2_nim_def_struct.hpp:242
nstd::optional< V2NIMTeamChatBannedMode > chatBannedMode
群禁言状态
Definition: v2_nim_def_struct.hpp:240
Definition: v2_nim_def_struct.hpp:2075
nstd::string filePath
文件地址
Definition: v2_nim_def_struct.hpp:2077
nstd::string sceneName
场景名
Definition: v2_nim_def_struct.hpp:2079
Definition: v2_nim_def_struct.hpp:2082
V2NIMUploadFileParams uploadParams
上传任务参数
Definition: v2_nim_def_struct.hpp:2086
nstd::string taskId
上传任务 ID
Definition: v2_nim_def_struct.hpp:2084
Definition: v2_nim_def_struct.hpp:1551
nstd::optional< nstd::string > birthday
用户生日
Definition: v2_nim_def_struct.hpp:1563
nstd::optional< nstd::string > avatar
用户头像
Definition: v2_nim_def_struct.hpp:1557
uint64_t createTime
用户资料创建时间
Definition: v2_nim_def_struct.hpp:1571
nstd::optional< nstd::string > email
用户邮箱
Definition: v2_nim_def_struct.hpp:1561
uint64_t updateTime
用户资料更新时间
Definition: v2_nim_def_struct.hpp:1573
nstd::string accountId
账号 ID
Definition: v2_nim_def_struct.hpp:1553
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition: v2_nim_def_struct.hpp:1569
nstd::optional< nstd::string > name
用户昵称
Definition: v2_nim_def_struct.hpp:1555
nstd::optional< uint32_t > gender
用户性别
Definition: v2_nim_def_struct.hpp:1567
nstd::optional< nstd::string > mobile
用户手机号
Definition: v2_nim_def_struct.hpp:1565
nstd::optional< nstd::string > sign
用户签名
Definition: v2_nim_def_struct.hpp:1559
Definition: v2_nim_def_struct.hpp:1849
nstd::string senderAvatar
发送方头像
Definition: v2_nim_def_struct.hpp:1855
nstd::string senderNick
发送方昵称
Definition: v2_nim_def_struct.hpp:1853
nstd::string senderExtension
发送方扩展字段
Definition: v2_nim_def_struct.hpp:1857
uint64_t userInfoTimestamp
消息发送者 uinfo 的最后更新时间
Definition: v2_nim_def_struct.hpp:1851
用户搜索选项
Definition: v2_nim_def_struct.hpp:1596
bool searchMobile
是否搜索手机号
Definition: v2_nim_def_struct.hpp:1604
bool searchAccountId
是否搜索用户账号
Definition: v2_nim_def_struct.hpp:1602
bool searchName
是否搜索用户昵称
Definition: v2_nim_def_struct.hpp:1600
nstd::string keyword
搜索关键字
Definition: v2_nim_def_struct.hpp:1598
事件订阅用户状态
Definition: v2_nim_def_struct.hpp:2429
nstd::optional< nstd::string > extension
用户发布状态时设置的扩展字段
Definition: v2_nim_def_struct.hpp:2443
uint32_t statusType
用户状态类型
Definition: v2_nim_def_struct.hpp:2433
time_t publishTime
用户发布状态的发布时间(服务器时间)
Definition: v2_nim_def_struct.hpp:2437
nstd::string accountId
用户账号 ID
Definition: v2_nim_def_struct.hpp:2431
nstd::optional< nstd::string > uniqueId
每次发布时会生成一个唯一 ID,发布自定义事件时会生成该参数,如果 ID 相同则表示同一个事件
Definition: v2_nim_def_struct.hpp:2439
V2NIMLoginClientType clientType
用户发布状态对应的终端 V2NIMLoginClientType
Definition: v2_nim_def_struct.hpp:2435
nstd::optional< uint32_t > duration
事件的有效期
Definition: v2_nim_def_struct.hpp:2441
nstd::optional< nstd::string > serverExtension
获取预留状态中的配置信息,由服务端填入 JSON array 格式
Definition: v2_nim_def_struct.hpp:2445
用户状态订阅结果
Definition: v2_nim_def_struct.hpp:2419
time_t subscribeTime
用户状态发布时的时间
Definition: v2_nim_def_struct.hpp:2425
nstd::string accountId
查询的用户账号
Definition: v2_nim_def_struct.hpp:2421
uint32_t duration
状态的有效期,单位秒,范围为 60s 到 30 天
Definition: v2_nim_def_struct.hpp:2423
Definition: v2_nim_def_struct.hpp:1576
nstd::optional< nstd::string > email
用户邮箱
Definition: v2_nim_def_struct.hpp:1584
nstd::optional< nstd::string > mobile
用户手机号
Definition: v2_nim_def_struct.hpp:1588
nstd::optional< uint32_t > gender
用户性别
Definition: v2_nim_def_struct.hpp:1590
nstd::optional< nstd::string > serverExtension
用户扩展字段
Definition: v2_nim_def_struct.hpp:1592
nstd::optional< nstd::string > sign
用户签名
Definition: v2_nim_def_struct.hpp:1582
nstd::optional< nstd::string > avatar
用户头像
Definition: v2_nim_def_struct.hpp:1580
nstd::optional< nstd::string > birthday
用户生日
Definition: v2_nim_def_struct.hpp:1586
nstd::optional< nstd::string > name
用户昵称
Definition: v2_nim_def_struct.hpp:1578
Definition: v2_nim_def_struct.hpp:1345
nstd::string voiceUrl
语音 url, 若为空则根据 voicePath 自动上传
Definition: v2_nim_def_struct.hpp:1349
nstd::string sampleRate
采样率
Definition: v2_nim_def_struct.hpp:1353
nstd::string voicePath
本地语音文件路径, 若为空则使用 url
Definition: v2_nim_def_struct.hpp:1347
nstd::string mimeType
音频类型, aac, wav, mp3, amr等
Definition: v2_nim_def_struct.hpp:1351
nstd::string sceneName
文件存储场景
Definition: v2_nim_def_struct.hpp:1357
uint64_t duration
语音时长, 单位毫秒
Definition: v2_nim_def_struct.hpp:1355