通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM C++ API Reference for Linux & Windows

概览 IRtmService IMessage SendMessageOptions PEER_SUBSCRIPTION_OPTION PeerOnlineStatus RtmAttribute IRtmChannelAttribute ChannelAttributeOptions AgoraRtmChannelMemberCount IChannel IChannelMember IRtmCallManager ILocalCallInvitation IRemoteCallInvitation IRtmServiceEventHandler IChannelEventHandler IRtmCallEventHandler 状态码和错误码
1//
2// Agora RTM SDK
3//
4//
5// Copyright (c) 2020 Agora.io. All rights reserved.
6//
7#pragma once
8
9#include <cstdint>
10#if defined(_WIN32)
11#define WIN32_LEAN_AND_MEAN
12#include <windows.h>
13#define AGORA_CALL __cdecl
14#if defined(AGORARTC_EXPORT)
15#define AGORA_API extern "C" __declspec(dllexport)
16#else
17#define AGORA_API extern "C" __declspec(dllimport)
18#endif
19#define _AGORA_CPP_API
20
21#elif defined(__APPLE__)
22#define AGORA_API __attribute__((visibility("default"))) extern "C"
23#define AGORA_CALL
24#define _AGORA_CPP_API
25
26#elif defined(__ANDROID__) || defined(__linux__)
27#if defined(__ANDROID__) && defined(FEATURE_RTM_STANDALONE_SDK)
28#define AGORA_API extern "C"
29#define _AGORA_CPP_API
30#else
31#define AGORA_API extern "C" __attribute__((visibility("default")))
32#define _AGORA_CPP_API __attribute__((visibility("default")))
33#endif
34#define AGORA_CALL
35
36#else
37#define AGORA_API extern "C"
38#define AGORA_CALL
39#define _AGORA_CPP_API
40#endif
41
42
46#define AGORA_RTM_ENDCALL_PREFIX "AgoraRTMLegacyEndcallCompatibleMessagePrefix"
47
48namespace agora {
49 namespace rtm {
50
54 enum INIT_ERR_CODE {
55
59 INIT_ERR_OK = 0,
60
64 INIT_ERR_FAILURE = 1,
65
69 INIT_ERR_ALREADY_INITIALIZED = 2,
70
74 INIT_ERR_INVALID_APP_ID = 3,
75
79 INIT_ERR_INVALID_ARGUMENT = 4,
80 };
81
85 enum LOGIN_ERR_CODE {
86
90 LOGIN_ERR_OK = 0,
91
95 LOGIN_ERR_UNKNOWN = 1,
96
100 LOGIN_ERR_REJECTED = 2, // Occurs when not initialized or server reject
101
105 LOGIN_ERR_INVALID_ARGUMENT = 3,
106
110 LOGIN_ERR_INVALID_APP_ID = 4,
111
115 LOGIN_ERR_INVALID_TOKEN = 5,
116
120 LOGIN_ERR_TOKEN_EXPIRED = 6,
121
125 LOGIN_ERR_NOT_AUTHORIZED = 7,
126
130 LOGIN_ERR_ALREADY_LOGIN = 8,
131
135 LOGIN_ERR_TIMEOUT = 9,
136
140 LOGIN_ERR_TOO_OFTEN = 10,
141
145 LOGIN_ERR_NOT_INITIALIZED = 101,
146 };
147
151 enum LOGOUT_ERR_CODE {
152
156 LOGOUT_ERR_OK = 0,
157
161 LOGOUT_ERR_REJECTED = 1,
162
166 LOGOUT_ERR_NOT_INITIALIZED = 101,
167
171 LOGOUT_ERR_USER_NOT_LOGGED_IN = 102,
172 };
173
177 enum RENEW_TOKEN_ERR_CODE {
178
182 RENEW_TOKEN_ERR_OK = 0,
183
187 RENEW_TOKEN_ERR_FAILURE = 1,
188
192 RENEW_TOKEN_ERR_INVALID_ARGUMENT = 2,
193
197 RENEW_TOKEN_ERR_REJECTED = 3,
198
202 RENEW_TOKEN_ERR_TOO_OFTEN = 4,
203
207 RENEW_TOKEN_ERR_TOKEN_EXPIRED = 5,
208
212 RENEW_TOKEN_ERR_INVALID_TOKEN = 6,
213
217 RENEW_TOKEN_ERR_NOT_INITIALIZED = 101,
218
222 RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN = 102,
223 };
224
228 enum CONNECTION_STATE {
229
235 CONNECTION_STATE_DISCONNECTED = 1,
236
243 CONNECTION_STATE_CONNECTING = 2,
244
252 CONNECTION_STATE_CONNECTED = 3,
253
260 CONNECTION_STATE_RECONNECTING = 4,
261
269 CONNECTION_STATE_ABORTED = 5,
270 };
271
275 enum CONNECTION_CHANGE_REASON {
276
280 CONNECTION_CHANGE_REASON_LOGIN = 1,
281
285 CONNECTION_CHANGE_REASON_LOGIN_SUCCESS = 2,
286
290 CONNECTION_CHANGE_REASON_LOGIN_FAILURE = 3,
291
295 CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT = 4,
296
300 CONNECTION_CHANGE_REASON_INTERRUPTED = 5,
301
305 CONNECTION_CHANGE_REASON_LOGOUT = 6,
306
310 CONNECTION_CHANGE_REASON_BANNED_BY_SERVER = 7,
311
315 CONNECTION_CHANGE_REASON_REMOTE_LOGIN = 8,
316
320 CONNECTION_CHANGE_REASON_TOKEN_EXPIRED = 9,
321 };
322
326 enum PEER_MESSAGE_ERR_CODE {
327
331 PEER_MESSAGE_ERR_OK = 0,
332
336 PEER_MESSAGE_ERR_FAILURE = 1,
337
341 PEER_MESSAGE_ERR_SENT_TIMEOUT = 2,
342
346 PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3,
347
351 PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4,
352
356 PEER_MESSAGE_ERR_TOO_OFTEN = 5,
357
361 PEER_MESSAGE_ERR_INVALID_USERID = 6,
362
366 PEER_MESSAGE_ERR_INVALID_MESSAGE = 7,
367
371 PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE = 8,
372
376 PEER_MESSAGE_ERR_NOT_INITIALIZED = 101,
377
381 PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
382 };
383
387 enum JOIN_CHANNEL_ERR {
388
392 JOIN_CHANNEL_ERR_OK = 0,
393
397 JOIN_CHANNEL_ERR_FAILURE = 1,
398
402 JOIN_CHANNEL_ERR_REJECTED = 2, // Usually occurs when the user is already in the channel
403
407 JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3,
408
412 JOIN_CHANNEL_TIMEOUT = 4,
413
417 JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5,
418
422 JOIN_CHANNEL_ERR_ALREADY_JOINED = 6,
423
427 JOIN_CHANNEL_ERR_TOO_OFTEN = 7,
428
432 JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8,
433
437 JOIN_CHANNEL_ERR_NOT_INITIALIZED = 101,
438
442 JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
443 };
444
448 enum LEAVE_CHANNEL_ERR {
449
453 LEAVE_CHANNEL_ERR_OK = 0,
454
458 LEAVE_CHANNEL_ERR_FAILURE = 1,
459
463 LEAVE_CHANNEL_ERR_REJECTED = 2, // Usually occurs when the user is not in the channel
464
468 LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL = 3,
469
473 LEAVE_CHANNEL_ERR_KICKED = 4,
474
478 LEAVE_CHANNEL_ERR_NOT_INITIALIZED = 101,
479
483 LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
484 };
485
489 enum LEAVE_CHANNEL_REASON {
490
494 LEAVE_CHANNEL_REASON_QUIT = 1,
495
499 LEAVE_CHANNEL_REASON_KICKED = 2,
500 };
501
505 enum CHANNEL_MESSAGE_ERR_CODE {
506
510 CHANNEL_MESSAGE_ERR_OK = 0,
511
515 CHANNEL_MESSAGE_ERR_FAILURE = 1,
516
520 CHANNEL_MESSAGE_ERR_SENT_TIMEOUT = 2,
521
525 CHANNEL_MESSAGE_ERR_TOO_OFTEN = 3,
526
530 CHANNEL_MESSAGE_ERR_INVALID_MESSAGE = 4,
531
535 CHANNEL_MESSAGE_ERR_NOT_INITIALIZED = 101,
536
540 CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
541 };
542
546 enum GET_MEMBERS_ERR {
547
551 GET_MEMBERS_ERR_OK = 0,
552
556 GET_MEMBERS_ERR_FAILURE = 1,
557
561 GET_MEMBERS_ERR_REJECTED = 2,
562
566 GET_MEMBERS_ERR_TIMEOUT = 3,
567
571 GET_MEMBERS_ERR_TOO_OFTEN = 4,
572
576 GET_MEMBERS_ERR_NOT_IN_CHANNEL = 5,
577
581 GET_MEMBERS_ERR_NOT_INITIALIZED = 101,
582
586 GET_MEMBERS_ERR_USER_NOT_LOGGED_IN = 102,
587 };
588
592 enum QUERY_PEERS_ONLINE_STATUS_ERR {
593
597 QUERY_PEERS_ONLINE_STATUS_ERR_OK = 0,
598
602 QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE = 1,
603
607 QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT = 2,
608
612 QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED = 3,
613
617 QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT = 4,
618
622 QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN = 5,
623
627 QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED = 101,
628
632 QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
633 };
634
638 enum PEER_ONLINE_STATE {
639
643 PEER_ONLINE_STATE_ONLINE = 0,
644
648 PEER_ONLINE_STATE_UNREACHABLE = 1,
649
653 PEER_ONLINE_STATE_OFFLINE = 2,
654 };
655
659 enum PEER_SUBSCRIPTION_OPTION {
663 PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS = 0,
664 };
665
669 enum PEER_SUBSCRIPTION_STATUS_ERR {
670
674 PEER_SUBSCRIPTION_STATUS_ERR_OK = 0,
675
679 PEER_SUBSCRIPTION_STATUS_ERR_FAILURE = 1,
680
684 PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT = 2,
685
689 PEER_SUBSCRIPTION_STATUS_ERR_REJECTED = 3,
690
694 PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT = 4,
695
699 PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN = 5,
700
704 PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW = 6,
705
709 PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED = 101,
710
714 PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
715 };
716
720 enum QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR {
721
725 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK = 0,
726
730 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE = 1,
731
735 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT = 2,
736
740 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN = 3,
741
745 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED = 101,
746
750 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN = 102,
751 };
752
756 enum ATTRIBUTE_OPERATION_ERR {
757
761 ATTRIBUTE_OPERATION_ERR_OK = 0,
762
766 ATTRIBUTE_OPERATION_ERR_NOT_READY = 1,
767
771 ATTRIBUTE_OPERATION_ERR_FAILURE = 2,
772
776 ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3,
777
784 ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4,
785
794 ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5,
795
799 ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6,
800
804 ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7,
805
809 ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101,
810
814 ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN = 102,
815 };
816
820 enum GET_CHANNEL_MEMBER_COUNT_ERR_CODE
821 {
822
826 GET_CHANNEL_MEMBER_COUNT_ERR_OK = 0,
827
831 GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE = 1,
832
836 GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT = 2,
837
841 GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN = 3,
842
846 GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT = 4,
847
851 GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT = 5,
852
856 GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED = 101,
857
861 GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN = 102,
862 };
863
867 enum DOWNLOAD_MEDIA_ERR_CODE {
871 DOWNLOAD_MEDIA_ERR_OK = 0,
872
876 DOWNLOAD_MEDIA_ERR_FAILURE = 1,
877
881 DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
885 DOWNLOAD_MEDIA_ERR_TIMEOUT = 3,
886
890 DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4,
891
895 DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
896
903 DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6,
904
908 DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
909
913 DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
914 };
915
916
920 enum UPLOAD_MEDIA_ERR_CODE {
924 UPLOAD_MEDIA_ERR_OK = 0,
925
929 UPLOAD_MEDIA_ERR_FAILURE = 1,
930
934 UPLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
935
939 UPLOAD_MEDIA_ERR_TIMEOUT = 3,
940
944 UPLOAD_MEDIA_ERR_SIZE_OVERFLOW = 4,
948 UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
955 UPLOAD_MEDIA_ERR_INTERRUPTED = 6,
956
960 UPLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
961
965 UPLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
966 };
967
971 enum CANCEL_MEDIA_ERR_CODE {
975 CANCEL_MEDIA_ERR_OK = 0,
976
980 CANCEL_MEDIA_ERR_FAILURE = 1,
981
985 CANCEL_MEDIA_ERR_NOT_EXIST = 2,
986
990 CANCEL_MEDIA_ERR_NOT_INITIALIZED = 101,
991
995 CANCEL_MEDIA_ERR_NOT_LOGGED_IN = 102,
996 };
997
1001 enum MESSAGE_TYPE {
1002
1006 MESSAGE_TYPE_UNDEFINED = 0,
1007
1011 MESSAGE_TYPE_TEXT = 1,
1012
1016 MESSAGE_TYPE_RAW = 2,
1017
1021 MESSAGE_TYPE_FILE = 3,
1022
1026 MESSAGE_TYPE_IMAGE = 4,
1027 };
1028
1032 struct SendMessageOptions{
1033
1044 bool enableOfflineMessaging;
1053 bool enableHistoricalMessaging;
1054
1055 SendMessageOptions()
1056 : enableOfflineMessaging(false)
1057
1058 , enableHistoricalMessaging(false)
1059
1060 {}
1061 };
1062
1066 struct RtmAttribute
1067 {
1068
1072 const char* key;
1073
1077 const char* value;
1078 };
1079
1083 struct MediaOperationProgress
1084 {
1085
1089 long long totalSize;
1090
1094 long long currentSize;
1095 };
1096
1100 class IRtmChannelAttribute
1101 {
1102 protected:
1103 virtual ~IRtmChannelAttribute() {}
1104 public:
1105
1111 virtual void setKey(const char *key) = 0;
1112
1118 virtual const char *getKey() const = 0;
1119
1125 virtual void setValue(const char *value) = 0;
1126
1132 virtual const char *getValue() const = 0;
1133
1139 virtual const char *getLastUpdateUserId() const = 0;
1140
1146 virtual long long getLastUpdateTs() const = 0;
1147
1151 virtual void release() = 0;
1152 };
1153
1157 struct ChannelAttributeOptions{
1158
1167 bool enableNotificationToChannelMembers;
1168 ChannelAttributeOptions():enableNotificationToChannelMembers(false){}
1169 };
1170
1174 class IMessage
1175 {
1176 protected:
1177 virtual ~IMessage() {}
1178 public:
1179
1185 virtual long long getMessageId() const = 0;
1186
1192 virtual MESSAGE_TYPE getMessageType() const = 0;
1193
1200 virtual void setText(const char *str) = 0;
1201
1207 virtual const char *getText() const = 0;
1208
1214 virtual const char *getRawMessageData() const = 0;
1215
1221 virtual int getRawMessageLength() const = 0;
1231 virtual long long getServerReceivedTs() const = 0;
1232
1244 virtual bool isOfflineMessage() const = 0;
1245
1251 virtual void release() = 0;
1252 };
1253
1257 class IFileMessage : public IMessage
1258 {
1259 public:
1260
1266 virtual long long getSize() const = 0;
1267
1277 virtual const char* getMediaId() const = 0;
1278
1285 virtual void setThumbnail(const uint8_t* thumbnail, int length) = 0;
1286
1292 virtual const char* getThumbnailData() const = 0;
1293
1299 virtual const long long getThumbnailLength() const = 0;
1300
1306 virtual void setFileName(const char* fileName) = 0;
1307
1313 virtual const char* getFileName() const = 0;
1314 };
1315
1319 class IImageMessage : public IMessage
1320 {
1321 public:
1327 virtual long long getSize() const = 0;
1328
1338 virtual const char* getMediaId() const = 0;
1339
1346 virtual void setThumbnail(const uint8_t* thumbnail, long long length) = 0;
1347
1353 virtual const char* getThumbnailData() const = 0;
1354
1360 virtual const long long getThumbnailLength() const = 0;
1361
1367 virtual void setFileName(const char* fileName) = 0;
1368
1374 virtual const char* getFileName() const = 0;
1375
1385 virtual void setWidth(int width) = 0;
1386
1396 virtual int getWidth() const = 0;
1397
1407 virtual void setHeight(int height) = 0;
1408
1418 virtual int getHeight() const = 0;
1419
1427 virtual void setThumbnailWidth(int width) = 0;
1428
1434 virtual int getThumbnailWidth() const = 0;
1435
1443 virtual void setThumbnailHeight(int height) = 0;
1444
1450 virtual int getThumbnailHeight() const = 0;
1451 };
1452
1456 class IChannelMember
1457 {
1458 protected:
1459 virtual ~IChannelMember() {}
1460 public:
1461
1467 virtual const char * getUserId() const = 0;
1468
1474 virtual const char * getChannelId() const = 0;
1475
1479 virtual void release() = 0;
1480 };
1481
1485 struct PeerOnlineStatus
1486 {
1487
1491 const char* peerId;
1492
1501 bool isOnline;
1502
1510 PEER_ONLINE_STATE onlineState;
1511 };
1512
1516 struct ChannelMemberCount
1517 {
1518
1522 const char* channelId;
1523
1529 int count;
1530 };
1531
1535 class IChannelEventHandler
1536 {
1537 public:
1538
1539 virtual ~IChannelEventHandler()
1540 {
1541 }
1542
1550 virtual void onJoinSuccess()
1551 {
1552 }
1553
1559 virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
1560 {
1561 (JOIN_CHANNEL_ERR) errorCode;
1562 }
1563
1569 virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
1570 {
1571 (LEAVE_CHANNEL_ERR) errorCode;
1572 }
1573
1582 virtual void onMessageReceived(const char *userId, const IMessage *message)
1583 {
1584 (const char *) userId;
1585 (IMessage *) message;
1586 }
1587
1596 virtual void onImageMessageReceived(const char *userId, const IImageMessage* message)
1597 {
1598 (IImageMessage *) message;
1599 }
1600
1609 virtual void onFileMessageReceived(const char *userId, const IFileMessage* message)
1610 {
1611 (IFileMessage *) message;
1612 }
1613
1624 virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
1625 {
1626 (long long) messageId;
1627 (CHANNEL_MESSAGE_ERR_CODE) state;
1628 }
1629
1639 virtual void onMemberJoined(IChannelMember *member)
1640 {
1641 (IChannelMember *) member;
1642 }
1643
1653 virtual void onMemberLeft(IChannelMember *member)
1654 {
1655 (IChannelMember *) member;
1656 }
1657
1669 virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
1670 {
1671 (IChannelMember **) members;
1672 (int) userCount;
1673 }
1674
1683 virtual void onAttributesUpdated(const IRtmChannelAttribute* attributes[], int numberOfAttributes)
1684 {
1685 (const IRtmChannelAttribute**) attributes;
1686 (int) numberOfAttributes;
1687 }
1688
1699 virtual void onMemberCountUpdated(int memberCount)
1700 {
1701 (int) memberCount;
1702 }
1703 };
1704
1708 class IChannel
1709 {
1710 protected:
1711 virtual ~IChannel() {}
1712 public:
1713// virtual void setEventHandler(IChannelEventHandler *eventHandler) = 0;
1714
1729 virtual int join() = 0;
1730
1742 virtual int leave() = 0;
1743
1760 virtual int sendMessage(const IMessage *message) = 0;
1761
1777 virtual int sendMessage(const IMessage *message, const SendMessageOptions &options) = 0;
1778
1784 virtual const char *getId() const = 0;
1785
1797 virtual int getMembers() = 0;
1798
1799 // sync_call
1800
1804 virtual void release() = 0;
1805 };
1806
1807 class IRtmServiceEventHandler
1808 {
1809 public:
1810 virtual ~IRtmServiceEventHandler()
1811 {
1812 }
1813
1819 virtual void onLoginSuccess() {}
1820
1826 virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
1827 {
1828 (LOGIN_ERR_CODE) errorCode;
1829 }
1830
1837 virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERR_CODE errorCode)
1838 {
1839 (const char*) token;
1840 (RENEW_TOKEN_ERR_CODE) errorCode;
1841 }
1842
1850 virtual void onTokenExpired()
1851 {
1852 }
1853
1860 virtual void onTokenPrivilegeWillExpire()
1861 {
1862 }
1863
1869 virtual void onLogout(LOGOUT_ERR_CODE errorCode)
1870 {
1871 (LOGOUT_ERR_CODE) errorCode;
1872 }
1873
1880 virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
1881 {
1882 }
1883
1890 virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
1891 {
1892 (long long) messageId;
1893 (PEER_MESSAGE_ERR_CODE) errorCode;
1894 }
1895
1902 virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
1903 {
1904 (char *) peerId;
1905 (IMessage *) message;
1906 }
1907
1908
1917 virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage* message)
1918 {
1919 (char *) peerId;
1920 (IImageMessage *) message;
1921 }
1922
1931 virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage* message)
1932 {
1933 (char *) peerId;
1934 (IFileMessage *) message;
1935 }
1936
1949 virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
1950 {
1951 (long long) requestId;
1952 (MediaOperationProgress) progress;
1953 }
1954
1955
1968 virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
1969 {
1970 (long long) requestId;
1971 (MediaOperationProgress) progress;
1972 }
1973
1981 virtual void onFileMediaUploadResult(long long requestId, IFileMessage* fileMessage, UPLOAD_MEDIA_ERR_CODE code)
1982 {
1983 (long long) requestId;
1984 (IFileMessage *) fileMessage;
1985 (UPLOAD_MEDIA_ERR_CODE) code;
1986 }
1987
1995 virtual void onImageMediaUploadResult(long long requestId, IImageMessage* imageMessage, UPLOAD_MEDIA_ERR_CODE code)
1996 {
1997 (long long) requestId;
1998 (IImageMessage *) imageMessage;
1999 (UPLOAD_MEDIA_ERR_CODE) code;
2000 }
2001
2008 virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
2009 {
2010 (long long)requestId;
2011 (DOWNLOAD_MEDIA_ERR_CODE)code;
2012 }
2013
2024 virtual void onMediaDownloadToMemoryResult(long long requestId, const char* memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
2025 {
2026 (long long) requestId;
2027 (const char*) memory;
2028 (long long) length;
2029 (DOWNLOAD_MEDIA_ERR_CODE) code;
2030 }
2031
2038 virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
2039 {
2040 (long long) requestId;
2041 (CANCEL_MEDIA_ERR_CODE) code;
2042 }
2043
2052 virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus* peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
2053 {
2054 (long long) requestId;
2055 (const PeerOnlineStatus*) peersStatus;
2056 (int) peerCount;
2057 (QUERY_PEERS_ONLINE_STATUS_ERR) errorCode;
2058 }
2059
2066 virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
2067 {
2068 (long long)requestId;
2069 (PEER_SUBSCRIPTION_STATUS_ERR)errorCode;
2070 }
2071
2080 virtual void onQueryPeersBySubscriptionOptionResult(long long requestId, const char* peerIds[], int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode)
2081 {
2082 (const char**)peerIds;
2083 (int)peerCount;
2084 (QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR)errorCode;
2085 }
2086
2097 virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
2098 {
2099 (const PeerOnlineStatus*)peersStatus;
2100 (int)peerCount;
2101 }
2102
2109 virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2110 {
2111 (long long) requestId;
2112 (ATTRIBUTE_OPERATION_ERR) errorCode;
2113 }
2114
2121 virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2122 {
2123 (long long) requestId;
2124 (ATTRIBUTE_OPERATION_ERR) errorCode;
2125 }
2126
2133 virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2134 {
2135 (long long) requestId;
2136 (ATTRIBUTE_OPERATION_ERR) errorCode;
2137 }
2138
2145 virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2146 {
2147 (long long) requestId;
2148 (ATTRIBUTE_OPERATION_ERR) errorCode;
2149 }
2150
2160 virtual void onGetUserAttributesResult(long long requestId, const char* userId, const RtmAttribute* attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2161 {
2162 (long long) requestId;
2163 (const RtmAttribute*) attributes;
2164 (int) numberOfAttributes;
2165 (ATTRIBUTE_OPERATION_ERR) errorCode;
2166 }
2167
2174 virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2175 {
2176 (long long) requestId;
2177 (ATTRIBUTE_OPERATION_ERR) errorCode;
2178 }
2179
2186 virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2187 {
2188 (long long) requestId;
2189 (ATTRIBUTE_OPERATION_ERR) errorCode;
2190 }
2191
2198 virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2199 {
2200 (long long) requestId;
2201 (ATTRIBUTE_OPERATION_ERR) errorCode;
2202 }
2203
2210 virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2211 {
2212 (long long) requestId;
2213 (ATTRIBUTE_OPERATION_ERR) errorCode;
2214 }
2215
2224 virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2225 {
2226 // (long long) requestId;
2227 // (const IRtmChannelAttribute**) attributes;
2228 // (int) numberOfAttributes;
2229 // (ATTRIBUTE_OPERATION_ERR) errorCode;
2230 }
2231
2240 virtual void onGetChannelMemberCountResult(long long requestId, const ChannelMemberCount* channelMemberCounts , int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode)
2241 {
2242 (long long) requestId;
2243 (const ChannelMemberCount*) channelMemberCounts;
2244 (int) channelCount;
2245 (GET_CHANNEL_MEMBER_COUNT_ERR_CODE)errorCode;
2246 }
2247 };
2248
2249 class IRtmCallManager;
2250 class IRtmCallEventHandler;
2251
2255 enum LOG_FILTER_TYPE
2256 {
2257
2261 LOG_FILTER_OFF = 0,
2262
2266 LOG_FILTER_INFO = 0x000f,
2267
2271 LOG_FILTER_WARN = 0x000e,
2272
2276 LOG_FILTER_ERROR = 0x000c,
2277
2281 LOG_FILTER_CRITICAL = 0x0008,
2282
2286 LOG_FILTER_MASK = 0x80f,
2287 };
2288
2289 class IRtmService
2290 {
2291 protected:
2292 virtual ~IRtmService() {}
2293 public:
2294
2306 virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler) = 0;
2307
2313 virtual void addEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2314
2320 virtual void removeEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2321
2325 virtual void release(bool sync = false) = 0;
2326
2356 virtual int login(const char *token, const char *userId) = 0;
2357
2366 virtual int logout() = 0;
2367
2378 virtual int renewToken(const char* token) = 0;
2379
2396 virtual int sendMessageToPeer(const char *peerId, const IMessage *message) = 0;
2397
2415 virtual int downloadMediaToMemory(const char* mediaId, long long &requestId) = 0;
2416
2431 virtual int downloadMediaToFile(const char* mediaId, const char* filePath, long long &requestId) = 0;
2432
2448 virtual int cancelMediaDownload(long long requestId) = 0;
2449
2465 virtual int cancelMediaUpload(long long requestId) = 0;
2466
2491 virtual int sendMessageToPeer(const char *peerId, const IMessage *message, const SendMessageOptions &options) = 0;
2492
2509 virtual IChannel * createChannel(const char *channelId, IChannelEventHandler *eventHandler) = 0;
2510
2521 virtual IRtmCallManager* getRtmCallManager(IRtmCallEventHandler*eventHandler) = 0;
2522
2533 virtual IMessage *createMessage() = 0;
2534
2546 virtual IMessage *createMessage(const char* message) = 0;
2547
2561 virtual IMessage *createMessage(const uint8_t* rawData, int length) = 0;
2562
2577 virtual IMessage *createMessage(const uint8_t* rawData, int length, const char* description) = 0;
2578
2590 virtual IFileMessage *createFileMessageByMediaId(const char* mediaId) = 0;
2591
2603 virtual IImageMessage *createImageMessageByMediaId(const char* mediaId) = 0;
2604
2622 virtual int createFileMessageByUploading(const char* filePath, long long &requestId) = 0;
2623
2644 virtual int createImageMessageByUploading(const char* filePath, long long &requestId) = 0;
2645
2651 virtual IRtmChannelAttribute *createChannelAttribute() = 0;
2652
2662 virtual int setParameters(const char* parameters) = 0;
2663// virtual int getParameters(const char* key, any_document_t& result) = 0;
2664
2682 virtual int queryPeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2683
2704 virtual int subscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2705
2718 virtual int unsubscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2719
2731 virtual int queryPeersBySubscriptionOption(PEER_SUBSCRIPTION_OPTION option, long long &requestId) = 0;
2732
2747 virtual int setLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2748
2766 virtual int addOrUpdateLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2767
2782 virtual int deleteLocalUserAttributesByKeys(const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2783
2796 virtual int clearLocalUserAttributes(long long &requestId) = 0;
2797
2811 virtual int getUserAttributes(const char* userId, long long &requestId) = 0;
2812
2828 virtual int getUserAttributesByKeys(const char* userId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2829
2850 virtual int setChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2851
2875 virtual int addOrUpdateChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2876
2897 virtual int deleteChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, const ChannelAttributeOptions &options, long long &requestId) = 0;
2898
2915 virtual int clearChannelAttributes(const char* channelId, const ChannelAttributeOptions &options, long long &requestId) = 0;
2916
2932 virtual int getChannelAttributes(const char* channelId, long long &requestId) = 0;
2933
2951 virtual int getChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2952
2969 virtual int getChannelMemberCount(const char* channelIds[], int channelCount, long long &requestId) = 0;
2970
2984 virtual int setLogFile(const char* logfile) = 0;
2985
2996 virtual int setLogFilter(LOG_FILTER_TYPE filter) = 0;
2997
3008 virtual int setLogFileSize(int fileSizeInKBytes) = 0;
3009 };
3011
3015
3023AGORA_API IRtmService* AGORA_CALL createRtmService();
3024
3026
3028
3029
3031
3035
3041AGORA_API const char* AGORA_CALL getRtmSdkVersion();
3042
3043#ifndef AGORA_SDK_BOTH_RTM_AND_RTC
3047enum RTM_AREA_CODE {
3051 AREA_CODE_CN = (1 << 0),
3055 AREA_CODE_NA = (1 << 1),
3059 AREA_CODE_EU = (1 << 2),
3063 AREA_CODE_AS = (1 << 3),
3067 AREA_CODE_JP = (1 << 4),
3071 AREA_CODE_IN = (1 << 5),
3075 AREA_CODE_GLOB = (0xFFFFFFFF)
3076};
3077#endif //AGORA_SDK_BOTH_RTM_AND_RTC
3078
3079/* Type of the cloud proxy. */
3080enum RTM_CLOUD_PROXY_TYPE {
3084 RTM_NONE_PROXY = 0,
3088 RTM_TCP_PROXY = 1
3089};
3090
3094struct RtmServiceContext
3095{
3099 int areaCode = AREA_CODE_GLOB;
3100
3104 RTM_CLOUD_PROXY_TYPE proxyType = RTM_NONE_PROXY;
3105};
3106
3110enum SET_RTM_SERVICE_CONTEXT_ERR_CODE
3111{
3115 SET_RTM_SERVICE_CONTEXT_ERR_OK = 0,
3119 SET_RTM_SERVICE_CONTEXT_ERR_FAILURE = 1,
3120};
3121
3131AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL setRtmServiceContext(const RtmServiceContext& context);
3132
3134
3136 }
3137}
agora::rtm::IChannelEventHandler
Agora RTM 频道方法回调。
Definition: IAgoraRtmService.h:1536
agora::rtm::IChannelEventHandler::onJoinSuccess
virtual void onJoinSuccess()
Definition: IAgoraRtmService.h:1550
agora::rtm::IChannelEventHandler::onFileMessageReceived
virtual void onFileMessageReceived(const char *userId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1609
agora::rtm::IChannelEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
Definition: IAgoraRtmService.h:1624
agora::rtm::IChannelEventHandler::onMemberJoined
virtual void onMemberJoined(IChannelMember *member)
Definition: IAgoraRtmService.h:1639
agora::rtm::IChannelEventHandler::onGetMembers
virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
Definition: IAgoraRtmService.h:1669
agora::rtm::IChannelEventHandler::onImageMessageReceived
virtual void onImageMessageReceived(const char *userId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1596
agora::rtm::IChannelEventHandler::onAttributesUpdated
virtual void onAttributesUpdated(const IRtmChannelAttribute *attributes[], int numberOfAttributes)
Definition: IAgoraRtmService.h:1683
agora::rtm::IChannelEventHandler::onMessageReceived
virtual void onMessageReceived(const char *userId, const IMessage *message)
Definition: IAgoraRtmService.h:1582
agora::rtm::IChannelEventHandler::~IChannelEventHandler
virtual ~IChannelEventHandler()
Definition: IAgoraRtmService.h:1539
agora::rtm::IChannelEventHandler::onLeave
virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1569
agora::rtm::IChannelEventHandler::onMemberLeft
virtual void onMemberLeft(IChannelMember *member)
Definition: IAgoraRtmService.h:1653
agora::rtm::IChannelEventHandler::onJoinFailure
virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1559
agora::rtm::IChannelEventHandler::onMemberCountUpdated
virtual void onMemberCountUpdated(int memberCount)
Definition: IAgoraRtmService.h:1699
agora::rtm::IChannel
Agora RTM 频道方法。
Definition: IAgoraRtmService.h:1709
agora::rtm::IChannel::sendMessage
virtual int sendMessage(const IMessage *message, const SendMessageOptions &options)=0
agora::rtm::IChannel::~IChannel
virtual ~IChannel()
Definition: IAgoraRtmService.h:1711
agora::rtm::IChannel::getMembers
virtual int getMembers()=0
agora::rtm::IChannel::sendMessage
virtual int sendMessage(const IMessage *message)=0
agora::rtm::IChannel::getId
virtual const char * getId() const =0
agora::rtm::IChannel::join
virtual int join()=0
agora::rtm::IChannel::leave
virtual int leave()=0
agora::rtm::IChannel::release
virtual void release()=0
agora::rtm::IChannelMember
用于获取 Agora RTM 频道成员属性的类。
Definition: IAgoraRtmService.h:1457
agora::rtm::IChannelMember::~IChannelMember
virtual ~IChannelMember()
Definition: IAgoraRtmService.h:1459
agora::rtm::IChannelMember::getChannelId
virtual const char * getChannelId() const =0
agora::rtm::IChannelMember::getUserId
virtual const char * getUserId() const =0
agora::rtm::IChannelMember::release
virtual void release()=0
agora::rtm::IFileMessage
用于设置或获取文件消息属性的类。可用于点对点或频道消息。
Definition: IAgoraRtmService.h:1258
agora::rtm::IFileMessage::getThumbnailData
virtual const char * getThumbnailData() const =0
agora::rtm::IFileMessage::getSize
virtual long long getSize() const =0
agora::rtm::IFileMessage::setFileName
virtual void setFileName(const char *fileName)=0
agora::rtm::IFileMessage::getThumbnailLength
virtual const long long getThumbnailLength() const =0
agora::rtm::IFileMessage::getFileName
virtual const char * getFileName() const =0
agora::rtm::IFileMessage::setThumbnail
virtual void setThumbnail(const uint8_t *thumbnail, int length)=0
agora::rtm::IFileMessage::getMediaId
virtual const char * getMediaId() const =0
agora::rtm::IImageMessage
用于设置或获取图片消息属性的类。可用于点对点或频道消息。
Definition: IAgoraRtmService.h:1320
agora::rtm::IImageMessage::getHeight
virtual int getHeight() const =0
agora::rtm::IImageMessage::getThumbnailWidth
virtual int getThumbnailWidth() const =0
agora::rtm::IImageMessage::getThumbnailLength
virtual const long long getThumbnailLength() const =0
agora::rtm::IImageMessage::setFileName
virtual void setFileName(const char *fileName)=0
agora::rtm::IImageMessage::setThumbnailWidth
virtual void setThumbnailWidth(int width)=0
agora::rtm::IImageMessage::setThumbnailHeight
virtual void setThumbnailHeight(int height)=0
agora::rtm::IImageMessage::getFileName
virtual const char * getFileName() const =0
agora::rtm::IImageMessage::setWidth
virtual void setWidth(int width)=0
agora::rtm::IImageMessage::getThumbnailData
virtual const char * getThumbnailData() const =0
agora::rtm::IImageMessage::getSize
virtual long long getSize() const =0
agora::rtm::IImageMessage::getThumbnailHeight
virtual int getThumbnailHeight() const =0
agora::rtm::IImageMessage::getWidth
virtual int getWidth() const =0
agora::rtm::IImageMessage::setThumbnail
virtual void setThumbnail(const uint8_t *thumbnail, long long length)=0
agora::rtm::IImageMessage::setHeight
virtual void setHeight(int height)=0
agora::rtm::IImageMessage::getMediaId
virtual const char * getMediaId() const =0
agora::rtm::IMessage
用于设置或获取 Agora RTM 消息属性的类。可用于点对点或频道消息。
Definition: IAgoraRtmService.h:1175
agora::rtm::IMessage::getRawMessageData
virtual const char * getRawMessageData() const =0
agora::rtm::IMessage::isOfflineMessage
virtual bool isOfflineMessage() const =0
agora::rtm::IMessage::~IMessage
virtual ~IMessage()
Definition: IAgoraRtmService.h:1177
agora::rtm::IMessage::getMessageId
virtual long long getMessageId() const =0
agora::rtm::IMessage::setText
virtual void setText(const char *str)=0
agora::rtm::IMessage::getText
virtual const char * getText() const =0
agora::rtm::IMessage::getMessageType
virtual MESSAGE_TYPE getMessageType() const =0
agora::rtm::IMessage::release
virtual void release()=0
agora::rtm::IMessage::getRawMessageLength
virtual int getRawMessageLength() const =0
agora::rtm::IMessage::getServerReceivedTs
virtual long long getServerReceivedTs() const =0
agora::rtm::IRtmCallEventHandler
Definition: IAgoraRtmCallManager.h:213
agora::rtm::IRtmCallManager
Definition: IAgoraRtmCallManager.h:309
agora::rtm::IRtmChannelAttribute
用于设置或获取频道属性的类。
Definition: IAgoraRtmService.h:1101
agora::rtm::IRtmChannelAttribute::getValue
virtual const char * getValue() const =0
agora::rtm::IRtmChannelAttribute::setKey
virtual void setKey(const char *key)=0
agora::rtm::IRtmChannelAttribute::~IRtmChannelAttribute
virtual ~IRtmChannelAttribute()
Definition: IAgoraRtmService.h:1103
agora::rtm::IRtmChannelAttribute::getLastUpdateTs
virtual long long getLastUpdateTs() const =0
agora::rtm::IRtmChannelAttribute::getLastUpdateUserId
virtual const char * getLastUpdateUserId() const =0
agora::rtm::IRtmChannelAttribute::getKey
virtual const char * getKey() const =0
agora::rtm::IRtmChannelAttribute::setValue
virtual void setValue(const char *value)=0
agora::rtm::IRtmServiceEventHandler
Definition: IAgoraRtmService.h:1808
agora::rtm::IRtmServiceEventHandler::onDeleteChannelAttributesResult
virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2198
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToFileResult
virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2008
agora::rtm::IRtmServiceEventHandler::onClearChannelAttributesResult
virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2210
agora::rtm::IRtmServiceEventHandler::onPeersOnlineStatusChanged
virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
Definition: IAgoraRtmService.h:2097
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateChannelAttributesResult
virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2186
agora::rtm::IRtmServiceEventHandler::onImageMessageReceivedFromPeer
virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1917
agora::rtm::IRtmServiceEventHandler::onDeleteLocalUserAttributesResult
virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2133
agora::rtm::IRtmServiceEventHandler::onLoginFailure
virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1826
agora::rtm::IRtmServiceEventHandler::onFileMessageReceivedFromPeer
virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1931
agora::rtm::IRtmServiceEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1890
agora::rtm::IRtmServiceEventHandler::onMediaUploadingProgress
virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1949
agora::rtm::IRtmServiceEventHandler::onLogout
virtual void onLogout(LOGOUT_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1869
agora::rtm::IRtmServiceEventHandler::onMediaCancelResult
virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2038
agora::rtm::IRtmServiceEventHandler::onGetUserAttributesResult
virtual void onGetUserAttributesResult(long long requestId, const char *userId, const RtmAttribute *attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2160
agora::rtm::IRtmServiceEventHandler::onTokenExpired
virtual void onTokenExpired()
Definition: IAgoraRtmService.h:1850
agora::rtm::IRtmServiceEventHandler::onQueryPeersOnlineStatusResult
virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus *peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2052
agora::rtm::IRtmServiceEventHandler::onSetChannelAttributesResult
virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2174
agora::rtm::IRtmServiceEventHandler::onGetChannelMemberCountResult
virtual void onGetChannelMemberCountResult(long long requestId, const ChannelMemberCount *channelMemberCounts, int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:2240
agora::rtm::IRtmServiceEventHandler::onLoginSuccess
virtual void onLoginSuccess()
Definition: IAgoraRtmService.h:1819
agora::rtm::IRtmServiceEventHandler::~IRtmServiceEventHandler
virtual ~IRtmServiceEventHandler()
Definition: IAgoraRtmService.h:1810
agora::rtm::IRtmServiceEventHandler::onClearLocalUserAttributesResult
virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2145
agora::rtm::IRtmServiceEventHandler::onRenewTokenResult
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1837
agora::rtm::IRtmServiceEventHandler::onMediaDownloadingProgress
virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1968
agora::rtm::IRtmServiceEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
Definition: IAgoraRtmService.h:1880
agora::rtm::IRtmServiceEventHandler::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire()
Definition: IAgoraRtmService.h:1860
agora::rtm::IRtmServiceEventHandler::onFileMediaUploadResult
virtual void onFileMediaUploadResult(long long requestId, IFileMessage *fileMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1981
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateLocalUserAttributesResult
virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2121
agora::rtm::IRtmServiceEventHandler::onGetChannelAttributesResult
virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2224
agora::rtm::IRtmServiceEventHandler::onImageMediaUploadResult
virtual void onImageMediaUploadResult(long long requestId, IImageMessage *imageMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1995
agora::rtm::IRtmServiceEventHandler::onQueryPeersBySubscriptionOptionResult
virtual void onQueryPeersBySubscriptionOptionResult(long long requestId, const char *peerIds[], int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode)
Definition: IAgoraRtmService.h:2080
agora::rtm::IRtmServiceEventHandler::onSetLocalUserAttributesResult
virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2109
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToMemoryResult
virtual void onMediaDownloadToMemoryResult(long long requestId, const char *memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2024
agora::rtm::IRtmServiceEventHandler::onSubscriptionRequestResult
virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2066
agora::rtm::IRtmServiceEventHandler::onMessageReceivedFromPeer
virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
Definition: IAgoraRtmService.h:1902
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:2290
agora::rtm::IRtmService::cancelMediaUpload
virtual int cancelMediaUpload(long long requestId)=0
agora::rtm::IRtmService::removeEventHandler
virtual void removeEventHandler(IRtmServiceEventHandler *eventHandler)=0
agora::rtm::IRtmService::unsubscribePeersOnlineStatus
virtual int unsubscribePeersOnlineStatus(const char *peerIds[], int peerCount, long long &requestId)=0
agora::rtm::IRtmService::queryPeersBySubscriptionOption
virtual int queryPeersBySubscriptionOption(PEER_SUBSCRIPTION_OPTION option, long long &requestId)=0
agora::rtm::IRtmService::setLogFile
virtual int setLogFile(const char *logfile)=0
agora::rtm::IRtmService::sendMessageToPeer
virtual int sendMessageToPeer(const char *peerId, const IMessage *message, const SendMessageOptions &options)=0
agora::rtm::IRtmService::addOrUpdateLocalUserAttributes
virtual int addOrUpdateLocalUserAttributes(const RtmAttribute *attributes, int numberOfAttributes, long long &requestId)=0
agora::rtm::IRtmService::getUserAttributes
virtual int getUserAttributes(const char *userId, long long &requestId)=0
agora::rtm::IRtmService::deleteChannelAttributesByKeys
virtual int deleteChannelAttributesByKeys(const char *channelId, const char *attributeKeys[], int numberOfKeys, const ChannelAttributeOptions &options, long long &requestId)=0
agora::rtm::IRtmService::login
virtual int login(const char *token, const char *userId)=0
agora::rtm::IRtmService::logout
virtual int logout()=0
agora::rtm::IRtmService::renewToken
virtual int renewToken(const char *token)=0
agora::rtm::IRtmService::subscribePeersOnlineStatus
virtual int subscribePeersOnlineStatus(const char *peerIds[], int peerCount, long long &requestId)=0
agora::rtm::IRtmService::queryPeersOnlineStatus
virtual int queryPeersOnlineStatus(const char *peerIds[], int peerCount, long long &requestId)=0
agora::rtm::IRtmService::getChannelAttributes
virtual int getChannelAttributes(const char *channelId, long long &requestId)=0
agora::rtm::IRtmService::setLogFilter
virtual int setLogFilter(LOG_FILTER_TYPE filter)=0
agora::rtm::IRtmService::getChannelMemberCount
virtual int getChannelMemberCount(const char *channelIds[], int channelCount, long long &requestId)=0
agora::rtm::IRtmService::createMessage
virtual IMessage * createMessage(const uint8_t *rawData, int length, const char *description)=0
agora::rtm::IRtmService::initialize
virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler)=0
agora::rtm::IRtmService::createMessage
virtual IMessage * createMessage()=0
agora::rtm::IRtmService::release
virtual void release(bool sync=false)=0
agora::rtm::IRtmService::downloadMediaToFile
virtual int downloadMediaToFile(const char *mediaId, const char *filePath, long long &requestId)=0
agora::rtm::IRtmService::createImageMessageByUploading
virtual int createImageMessageByUploading(const char *filePath, long long &requestId)=0
agora::rtm::IRtmService::createImageMessageByMediaId
virtual IImageMessage * createImageMessageByMediaId(const char *mediaId)=0
agora::rtm::IRtmService::createChannel
virtual IChannel * createChannel(const char *channelId, IChannelEventHandler *eventHandler)=0
agora::rtm::IRtmService::createChannelAttribute
virtual IRtmChannelAttribute * createChannelAttribute()=0
agora::rtm::IRtmService::setLocalUserAttributes
virtual int setLocalUserAttributes(const RtmAttribute *attributes, int numberOfAttributes, long long &requestId)=0
agora::rtm::IRtmService::addEventHandler
virtual void addEventHandler(IRtmServiceEventHandler *eventHandler)=0
agora::rtm::IRtmService::createFileMessageByUploading
virtual int createFileMessageByUploading(const char *filePath, long long &requestId)=0
agora::rtm::IRtmService::getRtmCallManager
virtual IRtmCallManager * getRtmCallManager(IRtmCallEventHandler *eventHandler)=0
agora::rtm::IRtmService::setChannelAttributes
virtual int setChannelAttributes(const char *channelId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId)=0
agora::rtm::IRtmService::~IRtmService
virtual ~IRtmService()
Definition: IAgoraRtmService.h:2292
agora::rtm::IRtmService::createMessage
virtual IMessage * createMessage(const char *message)=0
agora::rtm::IRtmService::createFileMessageByMediaId
virtual IFileMessage * createFileMessageByMediaId(const char *mediaId)=0
agora::rtm::IRtmService::getChannelAttributesByKeys
virtual int getChannelAttributesByKeys(const char *channelId, const char *attributeKeys[], int numberOfKeys, long long &requestId)=0
agora::rtm::IRtmService::createMessage
virtual IMessage * createMessage(const uint8_t *rawData, int length)=0
agora::rtm::IRtmService::deleteLocalUserAttributesByKeys
virtual int deleteLocalUserAttributesByKeys(const char *attributeKeys[], int numberOfKeys, long long &requestId)=0
agora::rtm::IRtmService::clearLocalUserAttributes
virtual int clearLocalUserAttributes(long long &requestId)=0
agora::rtm::IRtmService::cancelMediaDownload
virtual int cancelMediaDownload(long long requestId)=0
agora::rtm::IRtmService::downloadMediaToMemory
virtual int downloadMediaToMemory(const char *mediaId, long long &requestId)=0
agora::rtm::IRtmService::addOrUpdateChannelAttributes
virtual int addOrUpdateChannelAttributes(const char *channelId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId)=0
agora::rtm::IRtmService::setLogFileSize
virtual int setLogFileSize(int fileSizeInKBytes)=0
agora::rtm::IRtmService::getUserAttributesByKeys
virtual int getUserAttributesByKeys(const char *userId, const char *attributeKeys[], int numberOfKeys, long long &requestId)=0
agora::rtm::IRtmService::setParameters
virtual int setParameters(const char *parameters)=0
agora::rtm::IRtmService::sendMessageToPeer
virtual int sendMessageToPeer(const char *peerId, const IMessage *message)=0
agora::rtm::IRtmService::clearChannelAttributes
virtual int clearChannelAttributes(const char *channelId, const ChannelAttributeOptions &options, long long &requestId)=0
agora::rtm::createRtmService
AGORA_API IRtmService *AGORA_CALL createRtmService()
agora::rtm::RTM_AREA_CODE
RTM_AREA_CODE
Definition: IAgoraRtmService.h:3047
agora::rtm::setRtmServiceContext
AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL setRtmServiceContext(const RtmServiceContext &context)
agora::rtm::getRtmSdkVersion
AGORA_API const char *AGORA_CALL getRtmSdkVersion()
agora::rtm::RTM_CLOUD_PROXY_TYPE
RTM_CLOUD_PROXY_TYPE
Definition: IAgoraRtmService.h:3080
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_CODE
SET_RTM_SERVICE_CONTEXT_ERR_CODE
Definition: IAgoraRtmService.h:3111
agora::rtm::AREA_CODE_IN
@ AREA_CODE_IN
Definition: IAgoraRtmService.h:3071
agora::rtm::AREA_CODE_JP
@ AREA_CODE_JP
Definition: IAgoraRtmService.h:3067
agora::rtm::AREA_CODE_GLOB
@ AREA_CODE_GLOB
Definition: IAgoraRtmService.h:3075
agora::rtm::AREA_CODE_CN
@ AREA_CODE_CN
Definition: IAgoraRtmService.h:3051
agora::rtm::AREA_CODE_AS
@ AREA_CODE_AS
Definition: IAgoraRtmService.h:3063
agora::rtm::AREA_CODE_NA
@ AREA_CODE_NA
Definition: IAgoraRtmService.h:3055
agora::rtm::AREA_CODE_EU
@ AREA_CODE_EU
Definition: IAgoraRtmService.h:3059
agora::rtm::RTM_NONE_PROXY
@ RTM_NONE_PROXY
Definition: IAgoraRtmService.h:3084
agora::rtm::RTM_TCP_PROXY
@ RTM_TCP_PROXY
Definition: IAgoraRtmService.h:3088
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_OK
@ SET_RTM_SERVICE_CONTEXT_ERR_OK
Definition: IAgoraRtmService.h:3115
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
@ SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
Definition: IAgoraRtmService.h:3119
agora::rtm::LEAVE_CHANNEL_REASON
LEAVE_CHANNEL_REASON
离开频道原因。
Definition: IAgoraRtmService.h:489
agora::rtm::LEAVE_CHANNEL_REASON_QUIT
@ LEAVE_CHANNEL_REASON_QUIT
Definition: IAgoraRtmService.h:494
agora::rtm::LEAVE_CHANNEL_REASON_KICKED
@ LEAVE_CHANNEL_REASON_KICKED
Definition: IAgoraRtmService.h:499
agora::rtm::PEER_ONLINE_STATE
PEER_ONLINE_STATE
用户在线状态类型。
Definition: IAgoraRtmService.h:638
agora::rtm::PEER_ONLINE_STATE_UNREACHABLE
@ PEER_ONLINE_STATE_UNREACHABLE
Definition: IAgoraRtmService.h:648
agora::rtm::PEER_ONLINE_STATE_ONLINE
@ PEER_ONLINE_STATE_ONLINE
Definition: IAgoraRtmService.h:643
agora::rtm::PEER_ONLINE_STATE_OFFLINE
@ PEER_ONLINE_STATE_OFFLINE
Definition: IAgoraRtmService.h:653
agora::rtm::DOWNLOAD_MEDIA_ERR_CODE
DOWNLOAD_MEDIA_ERR_CODE
文件或图片下载相关错误码。
Definition: IAgoraRtmService.h:867
agora::rtm::DOWNLOAD_MEDIA_ERR_FAILURE
@ DOWNLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:876
agora::rtm::DOWNLOAD_MEDIA_ERR_INTERRUPTED
@ DOWNLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:903
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
@ DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:908
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_EXIST
@ DOWNLOAD_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:890
agora::rtm::DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:881
agora::rtm::DOWNLOAD_MEDIA_ERR_TIMEOUT
@ DOWNLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:885
agora::rtm::DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:895
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:913
agora::rtm::DOWNLOAD_MEDIA_ERR_OK
@ DOWNLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:871
agora::rtm::PEER_SUBSCRIPTION_OPTION
PEER_SUBSCRIPTION_OPTION
订阅类型。
Definition: IAgoraRtmService.h:659
agora::rtm::PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
@ PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
Definition: IAgoraRtmService.h:663
agora::rtm::LOGIN_ERR_CODE
LOGIN_ERR_CODE
登录相关错误码。
Definition: IAgoraRtmService.h:85
agora::rtm::LOGIN_ERR_INVALID_ARGUMENT
@ LOGIN_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:105
agora::rtm::LOGIN_ERR_OK
@ LOGIN_ERR_OK
Definition: IAgoraRtmService.h:90
agora::rtm::LOGIN_ERR_TOO_OFTEN
@ LOGIN_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:140
agora::rtm::LOGIN_ERR_TOKEN_EXPIRED
@ LOGIN_ERR_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:120
agora::rtm::LOGIN_ERR_INVALID_APP_ID
@ LOGIN_ERR_INVALID_APP_ID
Definition: IAgoraRtmService.h:110
agora::rtm::LOGIN_ERR_REJECTED
@ LOGIN_ERR_REJECTED
Definition: IAgoraRtmService.h:100
agora::rtm::LOGIN_ERR_UNKNOWN
@ LOGIN_ERR_UNKNOWN
Definition: IAgoraRtmService.h:95
agora::rtm::LOGIN_ERR_INVALID_TOKEN
@ LOGIN_ERR_INVALID_TOKEN
Definition: IAgoraRtmService.h:115
agora::rtm::LOGIN_ERR_NOT_AUTHORIZED
@ LOGIN_ERR_NOT_AUTHORIZED
Definition: IAgoraRtmService.h:125
agora::rtm::LOGIN_ERR_TIMEOUT
@ LOGIN_ERR_TIMEOUT
Definition: IAgoraRtmService.h:135
agora::rtm::LOGIN_ERR_NOT_INITIALIZED
@ LOGIN_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:145
agora::rtm::LOGIN_ERR_ALREADY_LOGIN
@ LOGIN_ERR_ALREADY_LOGIN
Definition: IAgoraRtmService.h:130
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR
PEER_SUBSCRIPTION_STATUS_ERR
订阅或退订指定用户状态相关错误码。
Definition: IAgoraRtmService.h:669
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OK
@ PEER_SUBSCRIPTION_STATUS_ERR_OK
Definition: IAgoraRtmService.h:674
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
@ PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:699
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
@ PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:684
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
@ PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:679
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
@ PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:714
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
@ PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
Definition: IAgoraRtmService.h:704
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
@ PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:709
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
@ PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:694
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
@ PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:689
agora::rtm::MESSAGE_TYPE
MESSAGE_TYPE
消息类型。
Definition: IAgoraRtmService.h:1001
agora::rtm::MESSAGE_TYPE_RAW
@ MESSAGE_TYPE_RAW
Definition: IAgoraRtmService.h:1016
agora::rtm::MESSAGE_TYPE_FILE
@ MESSAGE_TYPE_FILE
Definition: IAgoraRtmService.h:1021
agora::rtm::MESSAGE_TYPE_UNDEFINED
@ MESSAGE_TYPE_UNDEFINED
Definition: IAgoraRtmService.h:1006
agora::rtm::MESSAGE_TYPE_IMAGE
@ MESSAGE_TYPE_IMAGE
Definition: IAgoraRtmService.h:1026
agora::rtm::MESSAGE_TYPE_TEXT
@ MESSAGE_TYPE_TEXT
Definition: IAgoraRtmService.h:1011
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR
QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR
根据订阅类型获取被订阅用户列表相关的错误码。
Definition: IAgoraRtmService.h:720
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:740
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
Definition: IAgoraRtmService.h:730
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:745
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:750
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
Definition: IAgoraRtmService.h:725
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:735
agora::rtm::UPLOAD_MEDIA_ERR_CODE
UPLOAD_MEDIA_ERR_CODE
文件或图片上传相关错误码。
Definition: IAgoraRtmService.h:920
agora::rtm::UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:934
agora::rtm::UPLOAD_MEDIA_ERR_OK
@ UPLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:924
agora::rtm::UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
@ UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:944
agora::rtm::UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:948
agora::rtm::UPLOAD_MEDIA_ERR_INTERRUPTED
@ UPLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:955
agora::rtm::UPLOAD_MEDIA_ERR_TIMEOUT
@ UPLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:939
agora::rtm::UPLOAD_MEDIA_ERR_FAILURE
@ UPLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:929
agora::rtm::UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:965
agora::rtm::UPLOAD_MEDIA_ERR_NOT_INITIALIZED
@ UPLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:960
agora::rtm::INIT_ERR_CODE
INIT_ERR_CODE
初始化 Agora RTM 服务相关错误码。
Definition: IAgoraRtmService.h:54
agora::rtm::INIT_ERR_FAILURE
@ INIT_ERR_FAILURE
Definition: IAgoraRtmService.h:64
agora::rtm::INIT_ERR_INVALID_APP_ID
@ INIT_ERR_INVALID_APP_ID
Definition: IAgoraRtmService.h:74
agora::rtm::INIT_ERR_OK
@ INIT_ERR_OK
Definition: IAgoraRtmService.h:59
agora::rtm::INIT_ERR_INVALID_ARGUMENT
@ INIT_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:79
agora::rtm::INIT_ERR_ALREADY_INITIALIZED
@ INIT_ERR_ALREADY_INITIALIZED
Definition: IAgoraRtmService.h:69
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR
QUERY_PEERS_ONLINE_STATUS_ERR
查询用户在线状态相关的错误码。
Definition: IAgoraRtmService.h:592
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
@ QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:602
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
@ QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:627
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
@ QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:622
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
@ QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:632
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
@ QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:612
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
@ QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:607
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
@ QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:617
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_OK
@ QUERY_PEERS_ONLINE_STATUS_ERR_OK
Definition: IAgoraRtmService.h:597
agora::rtm::CONNECTION_CHANGE_REASON
CONNECTION_CHANGE_REASON
连接状态改变原因。
Definition: IAgoraRtmService.h:275
agora::rtm::CONNECTION_CHANGE_REASON_BANNED_BY_SERVER
@ CONNECTION_CHANGE_REASON_BANNED_BY_SERVER
Definition: IAgoraRtmService.h:310
agora::rtm::CONNECTION_CHANGE_REASON_REMOTE_LOGIN
@ CONNECTION_CHANGE_REASON_REMOTE_LOGIN
Definition: IAgoraRtmService.h:315
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT
@ CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT
Definition: IAgoraRtmService.h:295
agora::rtm::CONNECTION_CHANGE_REASON_LOGOUT
@ CONNECTION_CHANGE_REASON_LOGOUT
Definition: IAgoraRtmService.h:305
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_FAILURE
@ CONNECTION_CHANGE_REASON_LOGIN_FAILURE
Definition: IAgoraRtmService.h:290
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN
@ CONNECTION_CHANGE_REASON_LOGIN
Definition: IAgoraRtmService.h:280
agora::rtm::CONNECTION_CHANGE_REASON_INTERRUPTED
@ CONNECTION_CHANGE_REASON_INTERRUPTED
Definition: IAgoraRtmService.h:300
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_SUCCESS
@ CONNECTION_CHANGE_REASON_LOGIN_SUCCESS
Definition: IAgoraRtmService.h:285
agora::rtm::CONNECTION_CHANGE_REASON_TOKEN_EXPIRED
@ CONNECTION_CHANGE_REASON_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:320
agora::rtm::GET_MEMBERS_ERR
GET_MEMBERS_ERR
获取所在频道成员列表相关错误码。
Definition: IAgoraRtmService.h:546
agora::rtm::GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
@ GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:586
agora::rtm::GET_MEMBERS_ERR_NOT_IN_CHANNEL
@ GET_MEMBERS_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:576
agora::rtm::GET_MEMBERS_ERR_REJECTED
@ GET_MEMBERS_ERR_REJECTED
Definition: IAgoraRtmService.h:561
agora::rtm::GET_MEMBERS_ERR_FAILURE
@ GET_MEMBERS_ERR_FAILURE
Definition: IAgoraRtmService.h:556
agora::rtm::GET_MEMBERS_ERR_NOT_INITIALIZED
@ GET_MEMBERS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:581
agora::rtm::GET_MEMBERS_ERR_OK
@ GET_MEMBERS_ERR_OK
Definition: IAgoraRtmService.h:551
agora::rtm::GET_MEMBERS_ERR_TIMEOUT
@ GET_MEMBERS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:566
agora::rtm::GET_MEMBERS_ERR_TOO_OFTEN
@ GET_MEMBERS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:571
agora::rtm::ATTRIBUTE_OPERATION_ERR
ATTRIBUTE_OPERATION_ERR
属性相关操作错误码。
Definition: IAgoraRtmService.h:756
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
Definition: IAgoraRtmService.h:799
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
@ ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:809
agora::rtm::ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
@ ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:794
agora::rtm::ATTRIBUTE_OPERATION_ERR_OK
@ ATTRIBUTE_OPERATION_ERR_OK
Definition: IAgoraRtmService.h:761
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:814
agora::rtm::ATTRIBUTE_OPERATION_ERR_TIMEOUT
@ ATTRIBUTE_OPERATION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:804
agora::rtm::ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
@ ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:776
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_READY
@ ATTRIBUTE_OPERATION_ERR_NOT_READY
Definition: IAgoraRtmService.h:766
agora::rtm::ATTRIBUTE_OPERATION_ERR_FAILURE
@ ATTRIBUTE_OPERATION_ERR_FAILURE
Definition: IAgoraRtmService.h:771
agora::rtm::ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
@ ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:784
agora::rtm::CONNECTION_STATE
CONNECTION_STATE
SDK 与 Agora RTM 系统的连接状态。
Definition: IAgoraRtmService.h:228
agora::rtm::CONNECTION_STATE_ABORTED
@ CONNECTION_STATE_ABORTED
Definition: IAgoraRtmService.h:269
agora::rtm::CONNECTION_STATE_CONNECTING
@ CONNECTION_STATE_CONNECTING
Definition: IAgoraRtmService.h:243
agora::rtm::CONNECTION_STATE_RECONNECTING
@ CONNECTION_STATE_RECONNECTING
Definition: IAgoraRtmService.h:260
agora::rtm::CONNECTION_STATE_DISCONNECTED
@ CONNECTION_STATE_DISCONNECTED
Definition: IAgoraRtmService.h:235
agora::rtm::CONNECTION_STATE_CONNECTED
@ CONNECTION_STATE_CONNECTED
Definition: IAgoraRtmService.h:252
agora::rtm::RENEW_TOKEN_ERR_CODE
RENEW_TOKEN_ERR_CODE
更新 RTM Token 相关错误码。
Definition: IAgoraRtmService.h:177
agora::rtm::RENEW_TOKEN_ERR_TOO_OFTEN
@ RENEW_TOKEN_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:202
agora::rtm::RENEW_TOKEN_ERR_FAILURE
@ RENEW_TOKEN_ERR_FAILURE
Definition: IAgoraRtmService.h:187
agora::rtm::RENEW_TOKEN_ERR_OK
@ RENEW_TOKEN_ERR_OK
Definition: IAgoraRtmService.h:182
agora::rtm::RENEW_TOKEN_ERR_REJECTED
@ RENEW_TOKEN_ERR_REJECTED
Definition: IAgoraRtmService.h:197
agora::rtm::RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN
@ RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:222
agora::rtm::RENEW_TOKEN_ERR_INVALID_TOKEN
@ RENEW_TOKEN_ERR_INVALID_TOKEN
Definition: IAgoraRtmService.h:212
agora::rtm::RENEW_TOKEN_ERR_TOKEN_EXPIRED
@ RENEW_TOKEN_ERR_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:207
agora::rtm::RENEW_TOKEN_ERR_NOT_INITIALIZED
@ RENEW_TOKEN_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:217
agora::rtm::RENEW_TOKEN_ERR_INVALID_ARGUMENT
@ RENEW_TOKEN_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:192
agora::rtm::CHANNEL_MESSAGE_ERR_CODE
CHANNEL_MESSAGE_ERR_CODE
频道消息发送相关错误码。
Definition: IAgoraRtmService.h:505
agora::rtm::CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
@ CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:535
agora::rtm::CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:540
agora::rtm::CHANNEL_MESSAGE_ERR_FAILURE
@ CHANNEL_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:515
agora::rtm::CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
@ CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:520
agora::rtm::CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
@ CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:530
agora::rtm::CHANNEL_MESSAGE_ERR_TOO_OFTEN
@ CHANNEL_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:525
agora::rtm::CHANNEL_MESSAGE_ERR_OK
@ CHANNEL_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:510
agora::rtm::PEER_MESSAGE_ERR_CODE
PEER_MESSAGE_ERR_CODE
点对点消息发送相关错误码。
Definition: IAgoraRtmService.h:326
agora::rtm::PEER_MESSAGE_ERR_SENT_TIMEOUT
@ PEER_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:341
agora::rtm::PEER_MESSAGE_ERR_FAILURE
@ PEER_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:336
agora::rtm::PEER_MESSAGE_ERR_INVALID_MESSAGE
@ PEER_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:366
agora::rtm::PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
@ PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
Definition: IAgoraRtmService.h:371
agora::rtm::PEER_MESSAGE_ERR_NOT_INITIALIZED
@ PEER_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:376
agora::rtm::PEER_MESSAGE_ERR_PEER_UNREACHABLE
@ PEER_MESSAGE_ERR_PEER_UNREACHABLE
Definition: IAgoraRtmService.h:346
agora::rtm::PEER_MESSAGE_ERR_INVALID_USERID
@ PEER_MESSAGE_ERR_INVALID_USERID
Definition: IAgoraRtmService.h:361
agora::rtm::PEER_MESSAGE_ERR_CACHED_BY_SERVER
@ PEER_MESSAGE_ERR_CACHED_BY_SERVER
Definition: IAgoraRtmService.h:351
agora::rtm::PEER_MESSAGE_ERR_TOO_OFTEN
@ PEER_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:356
agora::rtm::PEER_MESSAGE_ERR_OK
@ PEER_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:331
agora::rtm::PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:381
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_CODE
GET_CHANNEL_MEMBER_COUNT_ERR_CODE
查询单个或多个指定频道成员人数的相关错误码。
Definition: IAgoraRtmService.h:821
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
@ GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:851
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_OK
@ GET_CHANNEL_MEMBER_COUNT_ERR_OK
Definition: IAgoraRtmService.h:826
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
@ GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
Definition: IAgoraRtmService.h:846
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
@ GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:841
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
@ GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:861
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
@ GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
Definition: IAgoraRtmService.h:831
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
@ GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:836
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
@ GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:856
agora::rtm::LEAVE_CHANNEL_ERR
LEAVE_CHANNEL_ERR
离开频道相关错误码。
Definition: IAgoraRtmService.h:448
agora::rtm::LEAVE_CHANNEL_ERR_OK
@ LEAVE_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:453
agora::rtm::LEAVE_CHANNEL_ERR_KICKED
@ LEAVE_CHANNEL_ERR_KICKED
Definition: IAgoraRtmService.h:473
agora::rtm::LEAVE_CHANNEL_ERR_NOT_INITIALIZED
@ LEAVE_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:478
agora::rtm::LEAVE_CHANNEL_ERR_REJECTED
@ LEAVE_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:463
agora::rtm::LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
@ LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:468
agora::rtm::LEAVE_CHANNEL_ERR_FAILURE
@ LEAVE_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:458
agora::rtm::LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:483
agora::rtm::JOIN_CHANNEL_ERR
JOIN_CHANNEL_ERR
加入频道相关错误码。
Definition: IAgoraRtmService.h:387
agora::rtm::JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
@ JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
Definition: IAgoraRtmService.h:432
agora::rtm::JOIN_CHANNEL_ERR_FAILURE
@ JOIN_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:397
agora::rtm::JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:442
agora::rtm::JOIN_CHANNEL_ERR_OK
@ JOIN_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:392
agora::rtm::JOIN_CHANNEL_ERR_REJECTED
@ JOIN_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:402
agora::rtm::JOIN_CHANNEL_ERR_TOO_OFTEN
@ JOIN_CHANNEL_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:427
agora::rtm::JOIN_CHANNEL_ERR_ALREADY_JOINED
@ JOIN_CHANNEL_ERR_ALREADY_JOINED
Definition: IAgoraRtmService.h:422
agora::rtm::JOIN_CHANNEL_TIMEOUT
@ JOIN_CHANNEL_TIMEOUT
Definition: IAgoraRtmService.h:412
agora::rtm::JOIN_CHANNEL_ERR_EXCEED_LIMIT
@ JOIN_CHANNEL_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:417
agora::rtm::JOIN_CHANNEL_ERR_NOT_INITIALIZED
@ JOIN_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:437
agora::rtm::JOIN_CHANNEL_ERR_INVALID_ARGUMENT
@ JOIN_CHANNEL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:407
agora::rtm::LOG_FILTER_TYPE
LOG_FILTER_TYPE
日志输出等级。
Definition: IAgoraRtmService.h:2256
agora::rtm::LOG_FILTER_ERROR
@ LOG_FILTER_ERROR
Definition: IAgoraRtmService.h:2276
agora::rtm::LOG_FILTER_CRITICAL
@ LOG_FILTER_CRITICAL
Definition: IAgoraRtmService.h:2281
agora::rtm::LOG_FILTER_INFO
@ LOG_FILTER_INFO
Definition: IAgoraRtmService.h:2266
agora::rtm::LOG_FILTER_MASK
@ LOG_FILTER_MASK
Definition: IAgoraRtmService.h:2286
agora::rtm::LOG_FILTER_WARN
@ LOG_FILTER_WARN
Definition: IAgoraRtmService.h:2271
agora::rtm::LOG_FILTER_OFF
@ LOG_FILTER_OFF
Definition: IAgoraRtmService.h:2261
agora::rtm::LOGOUT_ERR_CODE
LOGOUT_ERR_CODE
登出相关错误码。
Definition: IAgoraRtmService.h:151
agora::rtm::LOGOUT_ERR_OK
@ LOGOUT_ERR_OK
Definition: IAgoraRtmService.h:156
agora::rtm::LOGOUT_ERR_REJECTED
@ LOGOUT_ERR_REJECTED
Definition: IAgoraRtmService.h:161
agora::rtm::LOGOUT_ERR_USER_NOT_LOGGED_IN
@ LOGOUT_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:171
agora::rtm::LOGOUT_ERR_NOT_INITIALIZED
@ LOGOUT_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:166
agora::rtm::CANCEL_MEDIA_ERR_CODE
CANCEL_MEDIA_ERR_CODE
取消上传或取消下载相关的错误码。
Definition: IAgoraRtmService.h:971
agora::rtm::CANCEL_MEDIA_ERR_NOT_LOGGED_IN
@ CANCEL_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:995
agora::rtm::CANCEL_MEDIA_ERR_NOT_INITIALIZED
@ CANCEL_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:990
agora::rtm::CANCEL_MEDIA_ERR_NOT_EXIST
@ CANCEL_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:985
agora::rtm::CANCEL_MEDIA_ERR_OK
@ CANCEL_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:975
agora::rtm::CANCEL_MEDIA_ERR_FAILURE
@ CANCEL_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:980
agora
Definition: IAgoraRtmCallManager.h:11
agora::rtm::ChannelAttributeOptions
用于维护频道属性操作相关选项的数据结构。
Definition: IAgoraRtmService.h:1157
agora::rtm::ChannelAttributeOptions::enableNotificationToChannelMembers
bool enableNotificationToChannelMembers
Definition: IAgoraRtmService.h:1167
agora::rtm::ChannelAttributeOptions::ChannelAttributeOptions
ChannelAttributeOptions()
Definition: IAgoraRtmService.h:1168
agora::rtm::ChannelMemberCount
用于维护频道最新成员人数的数据结构。
Definition: IAgoraRtmService.h:1517
agora::rtm::ChannelMemberCount::count
int count
Definition: IAgoraRtmService.h:1529
agora::rtm::ChannelMemberCount::channelId
const char * channelId
Definition: IAgoraRtmService.h:1522
agora::rtm::MediaOperationProgress
用于维护文件上传下载比例的数据结构。
Definition: IAgoraRtmService.h:1084
agora::rtm::MediaOperationProgress::totalSize
long long totalSize
Definition: IAgoraRtmService.h:1089
agora::rtm::MediaOperationProgress::currentSize
long long currentSize
Definition: IAgoraRtmService.h:1094
agora::rtm::PeerOnlineStatus
存储 RTM 用户及其在线状态的数据结构。
Definition: IAgoraRtmService.h:1486
agora::rtm::PeerOnlineStatus::peerId
const char * peerId
Definition: IAgoraRtmService.h:1491
agora::rtm::PeerOnlineStatus::onlineState
PEER_ONLINE_STATE onlineState
Definition: IAgoraRtmService.h:1510
agora::rtm::PeerOnlineStatus::isOnline
bool isOnline
Definition: IAgoraRtmService.h:1501
agora::rtm::RtmAttribute
用于维护用户属性的数据结构。
Definition: IAgoraRtmService.h:1067
agora::rtm::RtmAttribute::value
const char * value
Definition: IAgoraRtmService.h:1077
agora::rtm::RtmAttribute::key
const char * key
Definition: IAgoraRtmService.h:1072
agora::rtm::RtmServiceContext
Definition: IAgoraRtmService.h:3095
agora::rtm::RtmServiceContext::areaCode
int areaCode
Definition: IAgoraRtmService.h:3099
agora::rtm::RtmServiceContext::proxyType
RTM_CLOUD_PROXY_TYPE proxyType
Definition: IAgoraRtmService.h:3104
agora::rtm::SendMessageOptions
消息发送选项。
Definition: IAgoraRtmService.h:1032
agora::rtm::SendMessageOptions::enableHistoricalMessaging
bool enableHistoricalMessaging
Definition: IAgoraRtmService.h:1053
agora::rtm::SendMessageOptions::enableOfflineMessaging
bool enableOfflineMessaging
Definition: IAgoraRtmService.h:1044
agora::rtm::SendMessageOptions::SendMessageOptions
SendMessageOptions()
Definition: IAgoraRtmService.h:1055