Signaling (previously RTM) SDK v1.5.0 API Reference for Windows (C++)
IAgoraRtmService.h
1//
2// The 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" __attribute__((visibility("default")))
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
82
86 enum LOGIN_ERR_CODE {
87
91 LOGIN_ERR_OK = 0,
92
96 LOGIN_ERR_UNKNOWN = 1,
97
101 LOGIN_ERR_REJECTED = 2, // Occurs when not initialized or server reject
102
106 LOGIN_ERR_INVALID_ARGUMENT = 3,
107
111 LOGIN_ERR_INVALID_APP_ID = 4,
112
116 LOGIN_ERR_INVALID_TOKEN = 5,
117
121 LOGIN_ERR_TOKEN_EXPIRED = 6,
122
126 LOGIN_ERR_NOT_AUTHORIZED = 7,
127
131 LOGIN_ERR_ALREADY_LOGGED_IN = 8,
132
136 LOGIN_ERR_TIMEOUT = 9,
137
141 LOGIN_ERR_TOO_OFTEN = 10,
142
146 LOGIN_ERR_NOT_INITIALIZED = 101,
147 };
148
152 enum LOGOUT_ERR_CODE {
153
157 LOGOUT_ERR_OK = 0,
158
162 LOGOUT_ERR_REJECTED = 1,
163
167 LOGOUT_ERR_NOT_INITIALIZED = 101,
168
172 LOGOUT_ERR_USER_NOT_LOGGED_IN = 102,
173 };
174
178 enum RENEW_TOKEN_ERR_CODE {
179
183 RENEW_TOKEN_ERR_OK = 0,
184
188 RENEW_TOKEN_ERR_FAILURE = 1,
189
193 RENEW_TOKEN_ERR_INVALID_ARGUMENT = 2,
194
198 RENEW_TOKEN_ERR_REJECTED = 3,
199
203 RENEW_TOKEN_ERR_TOO_OFTEN = 4,
204
208 RENEW_TOKEN_ERR_TOKEN_EXPIRED = 5,
209
213 RENEW_TOKEN_ERR_INVALID_TOKEN = 6,
214
218 RENEW_TOKEN_ERR_NOT_INITIALIZED = 101,
219
223 RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN = 102,
224 };
225
229 enum CONNECTION_STATE {
230
236 CONNECTION_STATE_DISCONNECTED = 1,
237
244 CONNECTION_STATE_CONNECTING = 2,
245
253 CONNECTION_STATE_CONNECTED = 3,
254
261 CONNECTION_STATE_RECONNECTING = 4,
262
268 CONNECTION_STATE_ABORTED = 5,
269 };
270
274 enum CONNECTION_CHANGE_REASON {
275
279 CONNECTION_CHANGE_REASON_LOGIN = 1,
280
284 CONNECTION_CHANGE_REASON_LOGIN_SUCCESS = 2,
285
289 CONNECTION_CHANGE_REASON_LOGIN_FAILURE = 3,
290
294 CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT = 4,
295
299 CONNECTION_CHANGE_REASON_INTERRUPTED = 5,
300
304 CONNECTION_CHANGE_REASON_LOGOUT = 6,
305
309 CONNECTION_CHANGE_REASON_BANNED_BY_SERVER = 7,
310
314 CONNECTION_CHANGE_REASON_REMOTE_LOGIN = 8,
315
319 CONNECTION_CHANGE_REASON_TOKEN_EXPIRED = 9,
320 };
321
325 enum PEER_MESSAGE_ERR_CODE {
326
330 PEER_MESSAGE_ERR_OK = 0,
331
335 PEER_MESSAGE_ERR_FAILURE = 1,
336
340 PEER_MESSAGE_ERR_SENT_TIMEOUT = 2,
341
345 PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3,
346
350 PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4,
351
355 PEER_MESSAGE_ERR_TOO_OFTEN = 5,
356
360 PEER_MESSAGE_ERR_INVALID_USERID = 6,
361
365 PEER_MESSAGE_ERR_INVALID_MESSAGE = 7,
366
370 PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE = 8,
371
375 PEER_MESSAGE_ERR_NOT_INITIALIZED = 101,
376
380 PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
381 };
382
386 enum JOIN_CHANNEL_ERR {
387
391 JOIN_CHANNEL_ERR_OK = 0,
392
396 JOIN_CHANNEL_ERR_FAILURE = 1,
397
401 JOIN_CHANNEL_ERR_REJECTED = 2, // Usually occurs when the user is already in the channel
402
406 JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3,
407
411 JOIN_CHANNEL_TIMEOUT = 4,
412
416 JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5,
417
421 JOIN_CHANNEL_ERR_ALREADY_JOINED = 6,
422
426 JOIN_CHANNEL_ERR_TOO_OFTEN = 7,
427
431 JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8,
432
436 JOIN_CHANNEL_ERR_NOT_INITIALIZED = 101,
437
441 JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
442 };
443
447 enum LEAVE_CHANNEL_ERR {
448
452 LEAVE_CHANNEL_ERR_OK = 0,
453
457 LEAVE_CHANNEL_ERR_FAILURE = 1,
458
462 LEAVE_CHANNEL_ERR_REJECTED = 2,
463
467 LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL = 3,
468
472 LEAVE_CHANNEL_ERR_KICKED = 4,
473
477 LEAVE_CHANNEL_ERR_NOT_INITIALIZED = 101,
478
482 LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
483 };
484
488 enum LEAVE_CHANNEL_REASON {
489
493 LEAVE_CHANNEL_REASON_QUIT = 1,
494
498 LEAVE_CHANNEL_REASON_KICKED = 2,
499 };
500
504 enum CHANNEL_MESSAGE_ERR_CODE {
505
509 CHANNEL_MESSAGE_ERR_OK = 0,
510
514 CHANNEL_MESSAGE_ERR_FAILURE = 1,
515
519 CHANNEL_MESSAGE_ERR_SENT_TIMEOUT = 2,
520
524 CHANNEL_MESSAGE_ERR_TOO_OFTEN = 3,
525
529 CHANNEL_MESSAGE_ERR_INVALID_MESSAGE = 4,
530
534 CHANNEL_MESSAGE_ERR_NOT_INITIALIZED = 101,
535
539 CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
540 };
541
545 enum GET_MEMBERS_ERR {
546
550 GET_MEMBERS_ERR_OK = 0,
551
555 GET_MEMBERS_ERR_FAILURE = 1,
556
560 GET_MEMBERS_ERR_REJECTED = 2,
561
565 GET_MEMBERS_ERR_TIMEOUT = 3,
566
570 GET_MEMBERS_ERR_TOO_OFTEN = 4,
571
575 GET_MEMBERS_ERR_NOT_IN_CHANNEL = 5,
576
580 GET_MEMBERS_ERR_NOT_INITIALIZED = 101,
581
585 GET_MEMBERS_ERR_USER_NOT_LOGGED_IN = 102,
586 };
587
591 enum QUERY_PEERS_ONLINE_STATUS_ERR {
592
596 QUERY_PEERS_ONLINE_STATUS_ERR_OK = 0,
597
601 QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE = 1,
602
606 QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT = 2,
607
611 QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED = 3,
612
616 QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT = 4,
617
621 QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN = 5,
622
626 QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED = 101,
627
631 QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
632 };
633
637 enum PEER_ONLINE_STATE {
638
642 PEER_ONLINE_STATE_ONLINE = 0,
643
647 PEER_ONLINE_STATE_UNREACHABLE = 1,
648
652 PEER_ONLINE_STATE_OFFLINE = 2,
653 };
654
658 enum PEER_SUBSCRIPTION_OPTION {
662 PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS = 0,
663 };
664
668 enum PEER_SUBSCRIPTION_STATUS_ERR {
669
673 PEER_SUBSCRIPTION_STATUS_ERR_OK = 0,
674
678 PEER_SUBSCRIPTION_STATUS_ERR_FAILURE = 1,
679
683 PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT = 2,
684
688 PEER_SUBSCRIPTION_STATUS_ERR_REJECTED = 3,
689
693 PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT = 4,
694
698 PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN = 5,
699
703 PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW = 6,
704
708 PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED = 101,
709
713 PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
714 };
715
719 enum QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR {
720
724 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK = 0,
725
729 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE = 1,
730
734 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT = 2,
735
739 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN = 3,
740
744 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED = 101,
745
749 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN = 102,
750 };
751
755 enum ATTRIBUTE_OPERATION_ERR {
756
760 ATTRIBUTE_OPERATION_ERR_OK = 0,
761
765 ATTRIBUTE_OPERATION_ERR_NOT_READY = 1,
766
770 ATTRIBUTE_OPERATION_ERR_FAILURE = 2,
771
775 ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3,
776
783 ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4,
784
793 ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5,
794
798 ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6,
799
803 ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7,
804
808 ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101,
809
813 ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN = 102,
814 };
815
819 enum GET_CHANNEL_MEMBER_COUNT_ERR_CODE {
820
824 GET_CHANNEL_MEMBER_COUNT_ERR_OK = 0,
825
829 GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE = 1,
830
834 GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT = 2,
835
839 GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN = 3,
840
844 GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT = 4,
845
849 GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT = 5,
850
854 GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED = 101,
855
859 GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN = 102,
860 };
861
865 enum DOWNLOAD_MEDIA_ERR_CODE {
869 DOWNLOAD_MEDIA_ERR_OK = 0,
870
874 DOWNLOAD_MEDIA_ERR_FAILURE = 1,
875
879 DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
883 DOWNLOAD_MEDIA_ERR_TIMEOUT = 3,
884
888 DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4,
889
893 DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
894
901 DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6,
902
906 DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
907
911 DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
912 };
913
914
918 enum UPLOAD_MEDIA_ERR_CODE {
922 UPLOAD_MEDIA_ERR_OK = 0,
923
927 UPLOAD_MEDIA_ERR_FAILURE = 1,
928
932 UPLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
933
937 UPLOAD_MEDIA_ERR_TIMEOUT = 3,
938
942 UPLOAD_MEDIA_ERR_SIZE_OVERFLOW = 4,
946 UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
953 UPLOAD_MEDIA_ERR_INTERRUPTED = 6,
954
958 UPLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
959
963 UPLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
964 };
965
969 enum CANCEL_MEDIA_ERR_CODE {
973 CANCEL_MEDIA_ERR_OK = 0,
974
978 CANCEL_MEDIA_ERR_FAILURE = 1,
979
983 CANCEL_MEDIA_ERR_NOT_EXIST = 2,
984
988 CANCEL_MEDIA_ERR_NOT_INITIALIZED = 101,
989
993 CANCEL_MEDIA_ERR_NOT_LOGGED_IN = 102,
994 };
995
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{
1043 bool enableOfflineMessaging;
1052 bool enableHistoricalMessaging;
1053
1054 SendMessageOptions()
1055 : enableOfflineMessaging(false)
1056
1057 , enableHistoricalMessaging(false)
1058
1059 {}
1060 };
1061
1065 struct RtmAttribute
1066 {
1067
1071 const char* key;
1072
1076 const char* value;
1077 };
1078
1082 struct MediaOperationProgress
1083 {
1087 long long totalSize;
1091 long long currentSize;
1092 };
1093
1097 class IRtmChannelAttribute
1098 {
1099 protected:
1100 virtual ~IRtmChannelAttribute() {}
1101 public:
1102
1108 virtual void setKey(const char *key) = 0;
1109
1115 virtual const char *getKey() const = 0;
1116
1122 virtual void setValue(const char *value) = 0;
1123
1129 virtual const char *getValue() const = 0;
1130
1136 virtual const char *getLastUpdateUserId() const = 0;
1137
1143 virtual long long getLastUpdateTs() const = 0;
1144
1148 virtual void release() = 0;
1149 };
1150
1154 struct ChannelAttributeOptions{
1155
1164 bool enableNotificationToChannelMembers;
1165 ChannelAttributeOptions():enableNotificationToChannelMembers(false){}
1166 };
1167
1171 class IMessage
1172 {
1173 protected:
1174 virtual ~IMessage() {}
1175 public:
1176
1182 virtual long long getMessageId() const = 0;
1183
1189 virtual MESSAGE_TYPE getMessageType() const = 0;
1190
1196 virtual void setText(const char *str) = 0;
1197
1203 virtual const char *getText() const = 0;
1204
1210 virtual const char *getRawMessageData() const = 0;
1211
1217 virtual int getRawMessageLength() const = 0;
1228 virtual long long getServerReceivedTs() const = 0;
1229
1241 virtual bool isOfflineMessage() const = 0;
1242
1248 virtual void release() = 0;
1249 };
1250
1254 class IFileMessage : public IMessage
1255 {
1256 public:
1257
1263 virtual long long getSize() const = 0;
1264
1274 virtual const char* getMediaId() const = 0;
1275
1282 virtual void setThumbnail(const uint8_t* thumbnail, int length) = 0;
1283
1289 virtual const char* getThumbnailData() const = 0;
1290
1296 virtual const long long getThumbnailLength() const = 0;
1297
1303 virtual void setFileName(const char* fileName) = 0;
1304
1310 virtual const char* getFileName() const = 0;
1311 };
1312
1316 class IImageMessage : public IMessage
1317 {
1318 public:
1324 virtual long long getSize() const = 0;
1325
1335 virtual const char* getMediaId() const = 0;
1336
1343 virtual void setThumbnail(const uint8_t* thumbnail, long long length) = 0;
1344
1350 virtual const char* getThumbnailData() const = 0;
1351
1357 virtual const long long getThumbnailLength() const = 0;
1358
1364 virtual void setFileName(const char* fileName) = 0;
1365
1371 virtual const char* getFileName() const = 0;
1372
1382 virtual void setWidth(int width) = 0;
1383
1393 virtual int getWidth() const = 0;
1394
1404 virtual void setHeight(int height) = 0;
1405
1415 virtual int getHeight() const = 0;
1416
1424 virtual void setThumbnailWidth(int width) = 0;
1425
1431 virtual int getThumbnailWidth() const = 0;
1432
1440 virtual void setThumbnailHeight(int height) = 0;
1441
1447 virtual int getThumbnailHeight() const = 0;
1448 };
1449
1453 class IChannelMember
1454 {
1455 protected:
1456 virtual ~IChannelMember() {}
1457 public:
1458
1464 virtual const char * getUserId() const = 0;
1465
1471 virtual const char * getChannelId() const = 0;
1472
1476 virtual void release() = 0;
1477 };
1478
1482 struct PeerOnlineStatus
1483 {
1484
1488 const char* peerId;
1489
1498 bool isOnline;
1499
1507 PEER_ONLINE_STATE onlineState;
1508 };
1509
1513 struct ChannelMemberCount
1514 {
1518 const char* channelId;
1519 // count of channel, 0 if channel not found.
1525 int count;
1526 };
1527
1531 class IChannelEventHandler
1532 {
1533 public:
1534
1535 virtual ~IChannelEventHandler()
1536 {
1537 }
1538
1546 virtual void onJoinSuccess()
1547 {
1548 }
1549
1557 virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
1558 {
1559 (JOIN_CHANNEL_ERR) errorCode;
1560 }
1561
1567 virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
1568 {
1569 (LEAVE_CHANNEL_ERR) errorCode;
1570 }
1571
1578 virtual void onMessageReceived(const char *userId, const IMessage *message)
1579 {
1580 (const char *) userId;
1581 (IMessage *) message;
1582 }
1591 virtual void onImageMessageReceived(const char *userId, const IImageMessage* message)
1592 {
1593 (IImageMessage *) message;
1594 }
1595
1604 virtual void onFileMessageReceived(const char *userId, const IFileMessage* message)
1605 {
1606 (IFileMessage *) message;
1607 }
1608
1615 virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
1616 {
1617 (long long) messageId;
1618 (CHANNEL_MESSAGE_ERR_CODE) state;
1619 }
1620
1630 virtual void onMemberJoined(IChannelMember *member)
1631 {
1632 (IChannelMember *) member;
1633 }
1634
1644 virtual void onMemberLeft(IChannelMember *member)
1645 {
1646 (IChannelMember *) member;
1647 }
1648
1658 virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
1659 {
1660 (IChannelMember **) members;
1661 (int) userCount;
1662 }
1663
1672 virtual void onAttributesUpdated(const IRtmChannelAttribute* attributes[], int numberOfAttributes)
1673 {
1674 (const IRtmChannelAttribute**) attributes;
1675 (int) numberOfAttributes;
1676 }
1677
1688 virtual void onMemberCountUpdated(int memberCount)
1689 {
1690 (int) memberCount;
1691 }
1692 };
1693
1697 class IChannel
1698 {
1699 protected:
1700 virtual ~IChannel() {}
1701 public:
1702// virtual void setEventHandler(IChannelEventHandler *eventHandler) = 0;
1703
1717 virtual int join() = 0;
1718
1730 virtual int leave() = 0;
1731
1748 virtual int sendMessage(const IMessage *message) = 0;
1749
1765 virtual int sendMessage(const IMessage *message, const SendMessageOptions &options) = 0;
1766
1772 virtual const char *getId() const = 0;
1773
1785 virtual int getMembers() = 0;
1786
1787 // sync_call
1788
1792 virtual void release() = 0;
1793 };
1794
1795 class IRtmServiceEventHandler
1796 {
1797 public:
1798 virtual ~IRtmServiceEventHandler()
1799 {
1800 }
1801
1807 virtual void onLoginSuccess() {}
1808
1814 virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
1815 {
1816 (LOGIN_ERR_CODE) errorCode;
1817 }
1818
1825 virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERR_CODE errorCode)
1826 {
1827 (const char*) token;
1828 (RENEW_TOKEN_ERR_CODE) errorCode;
1829 }
1830
1837 virtual void onTokenExpired()
1838 {
1839 }
1840
1847 virtual void onTokenPrivilegeWillExpire()
1848 {
1849 }
1850
1856 virtual void onLogout(LOGOUT_ERR_CODE errorCode)
1857 {
1858 (LOGOUT_ERR_CODE) errorCode;
1859 }
1860
1867 virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
1868 {
1869 }
1870
1878 virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
1879 {
1880 (long long) messageId;
1881 (PEER_MESSAGE_ERR_CODE) errorCode;
1882 }
1883
1890 virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
1891 {
1892 (char *) peerId;
1893 (IMessage *) message;
1894 }
1895
1904 virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage* message)
1905 {
1906 (char *) peerId;
1907 (IImageMessage *) message;
1908 }
1909
1918 virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage* message)
1919 {
1920 (char *) peerId;
1921 (IFileMessage *) message;
1922 }
1923
1936 virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
1937 {
1938 (long long) requestId;
1939 (MediaOperationProgress) progress;
1940 }
1941
1954 virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
1955 {
1956 (long long) requestId;
1957 (MediaOperationProgress) progress;
1958 }
1959
1967 virtual void onFileMediaUploadResult(long long requestId, IFileMessage* fileMessage, UPLOAD_MEDIA_ERR_CODE code)
1968 {
1969 (long long) requestId;
1970 (IFileMessage *) fileMessage;
1971 (UPLOAD_MEDIA_ERR_CODE) code;
1972 }
1973
1981 virtual void onImageMediaUploadResult(long long requestId, IImageMessage* imageMessage, UPLOAD_MEDIA_ERR_CODE code)
1982 {
1983 (long long) requestId;
1984 (IImageMessage *) imageMessage;
1985 (UPLOAD_MEDIA_ERR_CODE) code;
1986 }
1987
1994 virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
1995 {
1996 (long long)requestId;
1997 (DOWNLOAD_MEDIA_ERR_CODE)code;
1998 }
1999
2010 virtual void onMediaDownloadToMemoryResult(long long requestId, const char* memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
2011 {
2012 (long long) requestId;
2013 (const char*) memory;
2014 (long long) length;
2015 (DOWNLOAD_MEDIA_ERR_CODE) code;
2016 }
2017
2024 virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
2025 {
2026 (long long) requestId;
2027 (CANCEL_MEDIA_ERR_CODE) code;
2028 }
2029
2038 virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus* peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
2039 {
2040 (long long) requestId;
2041 (const PeerOnlineStatus*) peersStatus;
2042 (int) peerCount;
2043 (QUERY_PEERS_ONLINE_STATUS_ERR) errorCode;
2044 }
2045
2052 virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
2053 {
2054 (long long)requestId;
2055 (PEER_SUBSCRIPTION_STATUS_ERR)errorCode;
2056 }
2057
2066 virtual void onQueryPeersBySubscriptionOptionResult(long long requestId, const char* peerIds[], int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode)
2067 {
2068 (const char**)peerIds;
2069 (int)peerCount;
2070 (QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR)errorCode;
2071 }
2072
2083 virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
2084 {
2085 (const PeerOnlineStatus*)peersStatus;
2086 (int)peerCount;
2087 }
2088
2095 virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2096 {
2097 (long long) requestId;
2098 (ATTRIBUTE_OPERATION_ERR) errorCode;
2099 }
2100
2107 virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2108 {
2109 (long long) requestId;
2110 (ATTRIBUTE_OPERATION_ERR) errorCode;
2111 }
2112
2119 virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2120 {
2121 (long long) requestId;
2122 (ATTRIBUTE_OPERATION_ERR) errorCode;
2123 }
2124
2131 virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2132 {
2133 (long long) requestId;
2134 (ATTRIBUTE_OPERATION_ERR) errorCode;
2135 }
2136
2146 virtual void onGetUserAttributesResult(long long requestId, const char* userId, const RtmAttribute* attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2147 {
2148 (long long) requestId;
2149 (const RtmAttribute*) attributes;
2150 (int) numberOfAttributes;
2151 (ATTRIBUTE_OPERATION_ERR) errorCode;
2152 }
2153
2160 virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2161 {
2162 (long long) requestId;
2163 (ATTRIBUTE_OPERATION_ERR) errorCode;
2164 }
2165
2172 virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2173 {
2174 (long long) requestId;
2175 (ATTRIBUTE_OPERATION_ERR) errorCode;
2176 }
2177
2184 virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2185 {
2186 (long long) requestId;
2187 (ATTRIBUTE_OPERATION_ERR) errorCode;
2188 }
2189
2196 virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2197 {
2198 (long long) requestId;
2199 (ATTRIBUTE_OPERATION_ERR) errorCode;
2200 }
2201
2210 virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2211 {
2212// (long long) requestId;
2213// (const IRtmChannelAttribute**) attributes;
2214// (int) numberOfAttributes;
2215// (ATTRIBUTE_OPERATION_ERR) errorCode;
2216 }
2217
2226 virtual void onGetChannelMemberCountResult(long long requestId, const ChannelMemberCount* channelMemberCounts , int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode)
2227 {
2228 (long long) requestId;
2229 (const ChannelMemberCount*) channelMemberCounts;
2230 (int) channelCount;
2231 (GET_CHANNEL_MEMBER_COUNT_ERR_CODE)errorCode;
2232 }
2233 };
2234
2235 class IRtmCallManager;
2236 class IRtmCallEventHandler;
2237
2241 enum LOG_FILTER_TYPE
2242 {
2243
2247 LOG_FILTER_OFF = 0,
2248
2252 LOG_FILTER_INFO = 0x000f,
2253
2257 LOG_FILTER_WARN = 0x000e,
2258
2262 LOG_FILTER_ERROR = 0x000c,
2263
2267 LOG_FILTER_CRITICAL = 0x0008,
2271 LOG_FILTER_MASK = 0x80f,
2272 };
2273
2274 class IRtmService
2275 {
2276 protected:
2277 virtual ~IRtmService() {}
2278 public:
2279
2291 virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler) = 0;
2292
2298 virtual void addEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2299
2305 virtual void removeEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2306
2310 virtual void release(bool sync = false) = 0;
2311
2341 virtual int login(const char *token, const char *userId) = 0;
2342
2352 virtual int logout() = 0;
2353
2364 virtual int renewToken(const char* token) = 0;
2365
2379 virtual int sendMessageToPeer(const char *peerId, const IMessage *message) = 0;
2380
2398 virtual int downloadMediaToMemory(const char* mediaId, long long &requestId) = 0;
2399
2414 virtual int downloadMediaToFile(const char* mediaId, const char* filePath, long long &requestId) = 0;
2415
2431 virtual int cancelMediaDownload(long long requestId) = 0;
2432
2448 virtual int cancelMediaUpload(long long requestId) = 0;
2449
2450
2477 virtual int sendMessageToPeer(const char *peerId, const IMessage *message, const SendMessageOptions &options) = 0;
2478
2499 virtual IChannel * createChannel(const char *channelId, IChannelEventHandler *eventHandler) = 0;
2500
2511 virtual IRtmCallManager* getRtmCallManager(IRtmCallEventHandler*eventHandler) = 0;
2512
2523 virtual IMessage *createMessage() = 0;
2524
2536 virtual IMessage *createMessage(const char* message) = 0;
2537
2551 virtual IMessage *createMessage(const uint8_t* rawData, int length) = 0;
2552
2567 virtual IMessage *createMessage(const uint8_t* rawData, int length, const char* description) = 0;
2568
2580 virtual IFileMessage *createFileMessageByMediaId(const char* mediaId) = 0;
2581
2593 virtual IImageMessage *createImageMessageByMediaId(const char* mediaId) = 0;
2594
2613 virtual int createFileMessageByUploading(const char* filePath, long long &requestId) = 0;
2614
2635 virtual int createImageMessageByUploading(const char* filePath, long long &requestId) = 0;
2636
2642 virtual IRtmChannelAttribute *createChannelAttribute() = 0;
2643
2654 virtual int setParameters(const char* parameters) = 0;
2655// virtual int getParameters(const char* key, any_document_t& result) = 0;
2656
2672 virtual int queryPeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2673
2694 virtual int subscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2695
2708 virtual int unsubscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2709
2721 virtual int queryPeersBySubscriptionOption(PEER_SUBSCRIPTION_OPTION option, long long &requestId) = 0;
2722
2737 virtual int setLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2738
2755 virtual int addOrUpdateLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2756
2771 virtual int deleteLocalUserAttributesByKeys(const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2772
2785 virtual int clearLocalUserAttributes(long long &requestId) = 0;
2786
2800 virtual int getUserAttributes(const char* userId, long long &requestId) = 0;
2801
2817 virtual int getUserAttributesByKeys(const char* userId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2818
2839 virtual int setChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2840
2863 virtual int addOrUpdateChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2864
2885 virtual int deleteChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, const ChannelAttributeOptions &options, long long &requestId) = 0;
2886
2904 virtual int clearChannelAttributes(const char* channelId, const ChannelAttributeOptions &options, long long &requestId) = 0;
2905
2921 virtual int getChannelAttributes(const char* channelId, long long &requestId) = 0;
2922
2939 virtual int getChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2940
2958 virtual int getChannelMemberCount(const char* channelIds[], int channelCount, long long &requestId) = 0;
2959
2973 virtual int setLogFile(const char* logfile) = 0;
2974
2985 virtual int setLogFilter(LOG_FILTER_TYPE filter) = 0;
2986
2995 virtual int setLogFileSize(int fileSizeInKBytes) = 0;
2996 };
2998
3002
3010AGORA_API IRtmService* AGORA_CALL createRtmService();
3011
3013
3015
3017
3021
3027AGORA_API const char* AGORA_CALL getRtmSdkVersion();
3028
3029#ifndef AGORA_SDK_BOTH_RTM_AND_RTC
3033enum RTM_AREA_CODE {
3037 AREA_CODE_CN = (1 << 0),
3041 AREA_CODE_NA = (1 << 1),
3045 AREA_CODE_EU = (1 << 2),
3049 AREA_CODE_AS = (1 << 3),
3053 AREA_CODE_JP = (1 << 4),
3057 AREA_CODE_IN = (1 << 5),
3061 AREA_CODE_GLOB = (0xFFFFFFFF)
3062};
3063#endif //AGORA_SDK_BOTH_RTM_AND_RTC
3064
3065/* Type of the cloud proxy. */
3066enum RTM_CLOUD_PROXY_TYPE {
3070 RTM_NONE_PROXY = 0,
3074 RTM_TCP_PROXY = 1
3075};
3076
3080struct RtmServiceContext
3081{
3085 int areaCode = AREA_CODE_GLOB;
3086
3090 RTM_CLOUD_PROXY_TYPE proxyType = RTM_NONE_PROXY;
3091};
3092
3096enum SET_RTM_SERVICE_CONTEXT_ERR_CODE
3097{
3101 SET_RTM_SERVICE_CONTEXT_ERR_OK = 0,
3105 SET_RTM_SERVICE_CONTEXT_ERR_FAILURE = 1,
3106};
3107
3117AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL setRtmServiceContext(const RtmServiceContext& context);
3118
3120
3122 }
3123}
agora::rtm::IChannelEventHandler
Callbacks for the Agora RTM channel methods.
Definition: IAgoraRtmService.h:1532
agora::rtm::IChannelEventHandler::onJoinSuccess
virtual void onJoinSuccess()
Definition: IAgoraRtmService.h:1546
agora::rtm::IChannelEventHandler::onFileMessageReceived
virtual void onFileMessageReceived(const char *userId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1604
agora::rtm::IChannelEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
Definition: IAgoraRtmService.h:1615
agora::rtm::IChannelEventHandler::onMemberJoined
virtual void onMemberJoined(IChannelMember *member)
Definition: IAgoraRtmService.h:1630
agora::rtm::IChannelEventHandler::onGetMembers
virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
Definition: IAgoraRtmService.h:1658
agora::rtm::IChannelEventHandler::onImageMessageReceived
virtual void onImageMessageReceived(const char *userId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1591
agora::rtm::IChannelEventHandler::onAttributesUpdated
virtual void onAttributesUpdated(const IRtmChannelAttribute *attributes[], int numberOfAttributes)
Definition: IAgoraRtmService.h:1672
agora::rtm::IChannelEventHandler::onMessageReceived
virtual void onMessageReceived(const char *userId, const IMessage *message)
Definition: IAgoraRtmService.h:1578
agora::rtm::IChannelEventHandler::~IChannelEventHandler
virtual ~IChannelEventHandler()
Definition: IAgoraRtmService.h:1535
agora::rtm::IChannelEventHandler::onLeave
virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1567
agora::rtm::IChannelEventHandler::onMemberLeft
virtual void onMemberLeft(IChannelMember *member)
Definition: IAgoraRtmService.h:1644
agora::rtm::IChannelEventHandler::onJoinFailure
virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1557
agora::rtm::IChannelEventHandler::onMemberCountUpdated
virtual void onMemberCountUpdated(int memberCount)
Definition: IAgoraRtmService.h:1688
agora::rtm::IChannel
Agora RTM channel methods.
Definition: IAgoraRtmService.h:1698
agora::rtm::IChannel::sendMessage
virtual int sendMessage(const IMessage *message, const SendMessageOptions &options)=0
agora::rtm::IChannel::~IChannel
virtual ~IChannel()
Definition: IAgoraRtmService.h:1700
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
The class for retrieving the attributes of a channel member.
Definition: IAgoraRtmService.h:1454
agora::rtm::IChannelMember::~IChannelMember
virtual ~IChannelMember()
Definition: IAgoraRtmService.h:1456
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
The class for setting and retrieving attributes of a file message.
Definition: IAgoraRtmService.h:1255
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
The class for setting and retrieving attributes of an image message.
Definition: IAgoraRtmService.h:1317
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
The class for setting and retrieving attributes of a channel or peer-to-peer message.
Definition: IAgoraRtmService.h:1172
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:1174
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:312
agora::rtm::IRtmCallManager
Definition: IAgoraRtmCallManager.h:430
agora::rtm::IRtmChannelAttribute
The class for setting or getting attributes of a channel.
Definition: IAgoraRtmService.h:1098
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:1100
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:1796
agora::rtm::IRtmServiceEventHandler::onDeleteChannelAttributesResult
virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2184
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToFileResult
virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1994
agora::rtm::IRtmServiceEventHandler::onClearChannelAttributesResult
virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2196
agora::rtm::IRtmServiceEventHandler::onPeersOnlineStatusChanged
virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
Definition: IAgoraRtmService.h:2083
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateChannelAttributesResult
virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2172
agora::rtm::IRtmServiceEventHandler::onImageMessageReceivedFromPeer
virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1904
agora::rtm::IRtmServiceEventHandler::onDeleteLocalUserAttributesResult
virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2119
agora::rtm::IRtmServiceEventHandler::onLoginFailure
virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1814
agora::rtm::IRtmServiceEventHandler::onFileMessageReceivedFromPeer
virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1918
agora::rtm::IRtmServiceEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1878
agora::rtm::IRtmServiceEventHandler::onMediaUploadingProgress
virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1936
agora::rtm::IRtmServiceEventHandler::onLogout
virtual void onLogout(LOGOUT_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1856
agora::rtm::IRtmServiceEventHandler::onMediaCancelResult
virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2024
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:2146
agora::rtm::IRtmServiceEventHandler::onTokenExpired
virtual void onTokenExpired()
Definition: IAgoraRtmService.h:1837
agora::rtm::IRtmServiceEventHandler::onQueryPeersOnlineStatusResult
virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus *peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2038
agora::rtm::IRtmServiceEventHandler::onSetChannelAttributesResult
virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2160
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:2226
agora::rtm::IRtmServiceEventHandler::onLoginSuccess
virtual void onLoginSuccess()
Definition: IAgoraRtmService.h:1807
agora::rtm::IRtmServiceEventHandler::~IRtmServiceEventHandler
virtual ~IRtmServiceEventHandler()
Definition: IAgoraRtmService.h:1798
agora::rtm::IRtmServiceEventHandler::onClearLocalUserAttributesResult
virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2131
agora::rtm::IRtmServiceEventHandler::onRenewTokenResult
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1825
agora::rtm::IRtmServiceEventHandler::onMediaDownloadingProgress
virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1954
agora::rtm::IRtmServiceEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
Definition: IAgoraRtmService.h:1867
agora::rtm::IRtmServiceEventHandler::onTokenPrivilegeWillExpire
virtual void onTokenPrivilegeWillExpire()
Definition: IAgoraRtmService.h:1847
agora::rtm::IRtmServiceEventHandler::onFileMediaUploadResult
virtual void onFileMediaUploadResult(long long requestId, IFileMessage *fileMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1967
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateLocalUserAttributesResult
virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2107
agora::rtm::IRtmServiceEventHandler::onGetChannelAttributesResult
virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2210
agora::rtm::IRtmServiceEventHandler::onImageMediaUploadResult
virtual void onImageMediaUploadResult(long long requestId, IImageMessage *imageMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1981
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:2066
agora::rtm::IRtmServiceEventHandler::onSetLocalUserAttributesResult
virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2095
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToMemoryResult
virtual void onMediaDownloadToMemoryResult(long long requestId, const char *memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2010
agora::rtm::IRtmServiceEventHandler::onSubscriptionRequestResult
virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2052
agora::rtm::IRtmServiceEventHandler::onMessageReceivedFromPeer
virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
Definition: IAgoraRtmService.h:1890
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:2275
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:2277
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:3033
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:3066
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_CODE
SET_RTM_SERVICE_CONTEXT_ERR_CODE
Definition: IAgoraRtmService.h:3097
agora::rtm::AREA_CODE_IN
@ AREA_CODE_IN
Definition: IAgoraRtmService.h:3057
agora::rtm::AREA_CODE_JP
@ AREA_CODE_JP
Definition: IAgoraRtmService.h:3053
agora::rtm::AREA_CODE_GLOB
@ AREA_CODE_GLOB
Definition: IAgoraRtmService.h:3061
agora::rtm::AREA_CODE_CN
@ AREA_CODE_CN
Definition: IAgoraRtmService.h:3037
agora::rtm::AREA_CODE_AS
@ AREA_CODE_AS
Definition: IAgoraRtmService.h:3049
agora::rtm::AREA_CODE_NA
@ AREA_CODE_NA
Definition: IAgoraRtmService.h:3041
agora::rtm::AREA_CODE_EU
@ AREA_CODE_EU
Definition: IAgoraRtmService.h:3045
agora::rtm::RTM_NONE_PROXY
@ RTM_NONE_PROXY
Definition: IAgoraRtmService.h:3070
agora::rtm::RTM_TCP_PROXY
@ RTM_TCP_PROXY
Definition: IAgoraRtmService.h:3074
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_OK
@ SET_RTM_SERVICE_CONTEXT_ERR_OK
Definition: IAgoraRtmService.h:3101
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
@ SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
Definition: IAgoraRtmService.h:3105
agora::rtm::LEAVE_CHANNEL_REASON
LEAVE_CHANNEL_REASON
Reasons why a user leaves the channel.
Definition: IAgoraRtmService.h:488
agora::rtm::LEAVE_CHANNEL_REASON_QUIT
@ LEAVE_CHANNEL_REASON_QUIT
Definition: IAgoraRtmService.h:493
agora::rtm::LEAVE_CHANNEL_REASON_KICKED
@ LEAVE_CHANNEL_REASON_KICKED
Definition: IAgoraRtmService.h:498
agora::rtm::PEER_ONLINE_STATE
PEER_ONLINE_STATE
The online states of a peer.
Definition: IAgoraRtmService.h:637
agora::rtm::PEER_ONLINE_STATE_UNREACHABLE
@ PEER_ONLINE_STATE_UNREACHABLE
Definition: IAgoraRtmService.h:647
agora::rtm::PEER_ONLINE_STATE_ONLINE
@ PEER_ONLINE_STATE_ONLINE
Definition: IAgoraRtmService.h:642
agora::rtm::PEER_ONLINE_STATE_OFFLINE
@ PEER_ONLINE_STATE_OFFLINE
Definition: IAgoraRtmService.h:652
agora::rtm::DOWNLOAD_MEDIA_ERR_CODE
DOWNLOAD_MEDIA_ERR_CODE
Error codes related to downloading a file or image.
Definition: IAgoraRtmService.h:865
agora::rtm::DOWNLOAD_MEDIA_ERR_FAILURE
@ DOWNLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:874
agora::rtm::DOWNLOAD_MEDIA_ERR_INTERRUPTED
@ DOWNLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:901
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
@ DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:906
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_EXIST
@ DOWNLOAD_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:888
agora::rtm::DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:879
agora::rtm::DOWNLOAD_MEDIA_ERR_TIMEOUT
@ DOWNLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:883
agora::rtm::DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:893
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:911
agora::rtm::DOWNLOAD_MEDIA_ERR_OK
@ DOWNLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:869
agora::rtm::PEER_SUBSCRIPTION_OPTION
PEER_SUBSCRIPTION_OPTION
Subscription types.
Definition: IAgoraRtmService.h:658
agora::rtm::PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
@ PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
Definition: IAgoraRtmService.h:662
agora::rtm::LOGIN_ERR_CODE
LOGIN_ERR_CODE
Error codes related to login.
Definition: IAgoraRtmService.h:86
agora::rtm::LOGIN_ERR_INVALID_ARGUMENT
@ LOGIN_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:106
agora::rtm::LOGIN_ERR_OK
@ LOGIN_ERR_OK
Definition: IAgoraRtmService.h:91
agora::rtm::LOGIN_ERR_TOO_OFTEN
@ LOGIN_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:141
agora::rtm::LOGIN_ERR_TOKEN_EXPIRED
@ LOGIN_ERR_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:121
agora::rtm::LOGIN_ERR_INVALID_APP_ID
@ LOGIN_ERR_INVALID_APP_ID
Definition: IAgoraRtmService.h:111
agora::rtm::LOGIN_ERR_REJECTED
@ LOGIN_ERR_REJECTED
Definition: IAgoraRtmService.h:101
agora::rtm::LOGIN_ERR_UNKNOWN
@ LOGIN_ERR_UNKNOWN
Definition: IAgoraRtmService.h:96
agora::rtm::LOGIN_ERR_INVALID_TOKEN
@ LOGIN_ERR_INVALID_TOKEN
Definition: IAgoraRtmService.h:116
agora::rtm::LOGIN_ERR_NOT_AUTHORIZED
@ LOGIN_ERR_NOT_AUTHORIZED
Definition: IAgoraRtmService.h:126
agora::rtm::LOGIN_ERR_TIMEOUT
@ LOGIN_ERR_TIMEOUT
Definition: IAgoraRtmService.h:136
agora::rtm::LOGIN_ERR_NOT_INITIALIZED
@ LOGIN_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:146
agora::rtm::LOGIN_ERR_ALREADY_LOGGED_IN
@ LOGIN_ERR_ALREADY_LOGGED_IN
Definition: IAgoraRtmService.h:131
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR
PEER_SUBSCRIPTION_STATUS_ERR
Error codes related to subscribing to or unsubscribing from the status of specified peers.
Definition: IAgoraRtmService.h:668
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OK
@ PEER_SUBSCRIPTION_STATUS_ERR_OK
Definition: IAgoraRtmService.h:673
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
@ PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:698
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
@ PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:683
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
@ PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:678
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
@ PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:713
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
@ PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
Definition: IAgoraRtmService.h:703
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
@ PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:708
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
@ PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:693
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
@ PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:688
agora::rtm::MESSAGE_TYPE
MESSAGE_TYPE
Message types.
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
Error codes related to getting a list of the peers by subscription option type.
Definition: IAgoraRtmService.h:719
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:739
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
Definition: IAgoraRtmService.h:729
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:744
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:749
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
Definition: IAgoraRtmService.h:724
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:734
agora::rtm::UPLOAD_MEDIA_ERR_CODE
UPLOAD_MEDIA_ERR_CODE
Error codes related to uploading a file or image.
Definition: IAgoraRtmService.h:918
agora::rtm::UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:932
agora::rtm::UPLOAD_MEDIA_ERR_OK
@ UPLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:922
agora::rtm::UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
@ UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:942
agora::rtm::UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:946
agora::rtm::UPLOAD_MEDIA_ERR_INTERRUPTED
@ UPLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:953
agora::rtm::UPLOAD_MEDIA_ERR_TIMEOUT
@ UPLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:937
agora::rtm::UPLOAD_MEDIA_ERR_FAILURE
@ UPLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:927
agora::rtm::UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:963
agora::rtm::UPLOAD_MEDIA_ERR_NOT_INITIALIZED
@ UPLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:958
agora::rtm::INIT_ERR_CODE
INIT_ERR_CODE
Error codes related to Initialization.
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
Error codes related to querying the online status of the specified peers.
Definition: IAgoraRtmService.h:591
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
@ QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:601
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
@ QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:626
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
@ QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:621
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
@ QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:631
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
@ QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:611
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
@ QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:606
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
@ QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:616
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_OK
@ QUERY_PEERS_ONLINE_STATUS_ERR_OK
Definition: IAgoraRtmService.h:596
agora::rtm::CONNECTION_CHANGE_REASON
CONNECTION_CHANGE_REASON
Reasons for a connection state change.
Definition: IAgoraRtmService.h:274
agora::rtm::CONNECTION_CHANGE_REASON_BANNED_BY_SERVER
@ CONNECTION_CHANGE_REASON_BANNED_BY_SERVER
Definition: IAgoraRtmService.h:309
agora::rtm::CONNECTION_CHANGE_REASON_REMOTE_LOGIN
@ CONNECTION_CHANGE_REASON_REMOTE_LOGIN
Definition: IAgoraRtmService.h:314
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT
@ CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT
Definition: IAgoraRtmService.h:294
agora::rtm::CONNECTION_CHANGE_REASON_LOGOUT
@ CONNECTION_CHANGE_REASON_LOGOUT
Definition: IAgoraRtmService.h:304
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_FAILURE
@ CONNECTION_CHANGE_REASON_LOGIN_FAILURE
Definition: IAgoraRtmService.h:289
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN
@ CONNECTION_CHANGE_REASON_LOGIN
Definition: IAgoraRtmService.h:279
agora::rtm::CONNECTION_CHANGE_REASON_INTERRUPTED
@ CONNECTION_CHANGE_REASON_INTERRUPTED
Definition: IAgoraRtmService.h:299
agora::rtm::CONNECTION_CHANGE_REASON_LOGIN_SUCCESS
@ CONNECTION_CHANGE_REASON_LOGIN_SUCCESS
Definition: IAgoraRtmService.h:284
agora::rtm::CONNECTION_CHANGE_REASON_TOKEN_EXPIRED
@ CONNECTION_CHANGE_REASON_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:319
agora::rtm::GET_MEMBERS_ERR
GET_MEMBERS_ERR
Error codes related to retrieving a channel member list.
Definition: IAgoraRtmService.h:545
agora::rtm::GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
@ GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:585
agora::rtm::GET_MEMBERS_ERR_NOT_IN_CHANNEL
@ GET_MEMBERS_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:575
agora::rtm::GET_MEMBERS_ERR_REJECTED
@ GET_MEMBERS_ERR_REJECTED
Definition: IAgoraRtmService.h:560
agora::rtm::GET_MEMBERS_ERR_FAILURE
@ GET_MEMBERS_ERR_FAILURE
Definition: IAgoraRtmService.h:555
agora::rtm::GET_MEMBERS_ERR_NOT_INITIALIZED
@ GET_MEMBERS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:580
agora::rtm::GET_MEMBERS_ERR_OK
@ GET_MEMBERS_ERR_OK
Definition: IAgoraRtmService.h:550
agora::rtm::GET_MEMBERS_ERR_TIMEOUT
@ GET_MEMBERS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:565
agora::rtm::GET_MEMBERS_ERR_TOO_OFTEN
@ GET_MEMBERS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:570
agora::rtm::ATTRIBUTE_OPERATION_ERR
ATTRIBUTE_OPERATION_ERR
Error codes related to attrubute operations.
Definition: IAgoraRtmService.h:755
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
Definition: IAgoraRtmService.h:798
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
@ ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:808
agora::rtm::ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
@ ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:793
agora::rtm::ATTRIBUTE_OPERATION_ERR_OK
@ ATTRIBUTE_OPERATION_ERR_OK
Definition: IAgoraRtmService.h:760
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:813
agora::rtm::ATTRIBUTE_OPERATION_ERR_TIMEOUT
@ ATTRIBUTE_OPERATION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:803
agora::rtm::ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
@ ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:775
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_READY
@ ATTRIBUTE_OPERATION_ERR_NOT_READY
Definition: IAgoraRtmService.h:765
agora::rtm::ATTRIBUTE_OPERATION_ERR_FAILURE
@ ATTRIBUTE_OPERATION_ERR_FAILURE
Definition: IAgoraRtmService.h:770
agora::rtm::ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
@ ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:783
agora::rtm::CONNECTION_STATE
CONNECTION_STATE
Connection states between the SDK and the Agora RTM system.
Definition: IAgoraRtmService.h:229
agora::rtm::CONNECTION_STATE_ABORTED
@ CONNECTION_STATE_ABORTED
Definition: IAgoraRtmService.h:268
agora::rtm::CONNECTION_STATE_CONNECTING
@ CONNECTION_STATE_CONNECTING
Definition: IAgoraRtmService.h:244
agora::rtm::CONNECTION_STATE_RECONNECTING
@ CONNECTION_STATE_RECONNECTING
Definition: IAgoraRtmService.h:261
agora::rtm::CONNECTION_STATE_DISCONNECTED
@ CONNECTION_STATE_DISCONNECTED
Definition: IAgoraRtmService.h:236
agora::rtm::CONNECTION_STATE_CONNECTED
@ CONNECTION_STATE_CONNECTED
Definition: IAgoraRtmService.h:253
agora::rtm::RENEW_TOKEN_ERR_CODE
RENEW_TOKEN_ERR_CODE
Error codes related to renewing the RTM Token.
Definition: IAgoraRtmService.h:178
agora::rtm::RENEW_TOKEN_ERR_TOO_OFTEN
@ RENEW_TOKEN_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:203
agora::rtm::RENEW_TOKEN_ERR_FAILURE
@ RENEW_TOKEN_ERR_FAILURE
Definition: IAgoraRtmService.h:188
agora::rtm::RENEW_TOKEN_ERR_OK
@ RENEW_TOKEN_ERR_OK
Definition: IAgoraRtmService.h:183
agora::rtm::RENEW_TOKEN_ERR_REJECTED
@ RENEW_TOKEN_ERR_REJECTED
Definition: IAgoraRtmService.h:198
agora::rtm::RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN
@ RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:223
agora::rtm::RENEW_TOKEN_ERR_INVALID_TOKEN
@ RENEW_TOKEN_ERR_INVALID_TOKEN
Definition: IAgoraRtmService.h:213
agora::rtm::RENEW_TOKEN_ERR_TOKEN_EXPIRED
@ RENEW_TOKEN_ERR_TOKEN_EXPIRED
Definition: IAgoraRtmService.h:208
agora::rtm::RENEW_TOKEN_ERR_NOT_INITIALIZED
@ RENEW_TOKEN_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:218
agora::rtm::RENEW_TOKEN_ERR_INVALID_ARGUMENT
@ RENEW_TOKEN_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:193
agora::rtm::CHANNEL_MESSAGE_ERR_CODE
CHANNEL_MESSAGE_ERR_CODE
Error codes related to sending a channel message.
Definition: IAgoraRtmService.h:504
agora::rtm::CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
@ CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:534
agora::rtm::CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:539
agora::rtm::CHANNEL_MESSAGE_ERR_FAILURE
@ CHANNEL_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:514
agora::rtm::CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
@ CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:519
agora::rtm::CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
@ CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:529
agora::rtm::CHANNEL_MESSAGE_ERR_TOO_OFTEN
@ CHANNEL_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:524
agora::rtm::CHANNEL_MESSAGE_ERR_OK
@ CHANNEL_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:509
agora::rtm::PEER_MESSAGE_ERR_CODE
PEER_MESSAGE_ERR_CODE
Error codes related to sending a peer-to-peer message.
Definition: IAgoraRtmService.h:325
agora::rtm::PEER_MESSAGE_ERR_SENT_TIMEOUT
@ PEER_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:340
agora::rtm::PEER_MESSAGE_ERR_FAILURE
@ PEER_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:335
agora::rtm::PEER_MESSAGE_ERR_INVALID_MESSAGE
@ PEER_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:365
agora::rtm::PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
@ PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
Definition: IAgoraRtmService.h:370
agora::rtm::PEER_MESSAGE_ERR_NOT_INITIALIZED
@ PEER_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:375
agora::rtm::PEER_MESSAGE_ERR_PEER_UNREACHABLE
@ PEER_MESSAGE_ERR_PEER_UNREACHABLE
Definition: IAgoraRtmService.h:345
agora::rtm::PEER_MESSAGE_ERR_INVALID_USERID
@ PEER_MESSAGE_ERR_INVALID_USERID
Definition: IAgoraRtmService.h:360
agora::rtm::PEER_MESSAGE_ERR_CACHED_BY_SERVER
@ PEER_MESSAGE_ERR_CACHED_BY_SERVER
Definition: IAgoraRtmService.h:350
agora::rtm::PEER_MESSAGE_ERR_TOO_OFTEN
@ PEER_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:355
agora::rtm::PEER_MESSAGE_ERR_OK
@ PEER_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:330
agora::rtm::PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:380
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_CODE
GET_CHANNEL_MEMBER_COUNT_ERR_CODE
Error codes related to retrieving the channel member count of specified channels.
Definition: IAgoraRtmService.h:819
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
@ GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:849
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_OK
@ GET_CHANNEL_MEMBER_COUNT_ERR_OK
Definition: IAgoraRtmService.h:824
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
@ GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
Definition: IAgoraRtmService.h:844
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
@ GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:839
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
@ GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:859
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
@ GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
Definition: IAgoraRtmService.h:829
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
@ GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:834
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
@ GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:854
agora::rtm::LEAVE_CHANNEL_ERR
LEAVE_CHANNEL_ERR
Error codes related to leaving a channel.
Definition: IAgoraRtmService.h:447
agora::rtm::LEAVE_CHANNEL_ERR_OK
@ LEAVE_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:452
agora::rtm::LEAVE_CHANNEL_ERR_KICKED
@ LEAVE_CHANNEL_ERR_KICKED
Definition: IAgoraRtmService.h:472
agora::rtm::LEAVE_CHANNEL_ERR_NOT_INITIALIZED
@ LEAVE_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:477
agora::rtm::LEAVE_CHANNEL_ERR_REJECTED
@ LEAVE_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:462
agora::rtm::LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
@ LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:467
agora::rtm::LEAVE_CHANNEL_ERR_FAILURE
@ LEAVE_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:457
agora::rtm::LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:482
agora::rtm::JOIN_CHANNEL_ERR
JOIN_CHANNEL_ERR
Error codes related to joining a channel.
Definition: IAgoraRtmService.h:386
agora::rtm::JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
@ JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
Definition: IAgoraRtmService.h:431
agora::rtm::JOIN_CHANNEL_ERR_FAILURE
@ JOIN_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:396
agora::rtm::JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:441
agora::rtm::JOIN_CHANNEL_ERR_OK
@ JOIN_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:391
agora::rtm::JOIN_CHANNEL_ERR_REJECTED
@ JOIN_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:401
agora::rtm::JOIN_CHANNEL_ERR_TOO_OFTEN
@ JOIN_CHANNEL_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:426
agora::rtm::JOIN_CHANNEL_ERR_ALREADY_JOINED
@ JOIN_CHANNEL_ERR_ALREADY_JOINED
Definition: IAgoraRtmService.h:421
agora::rtm::JOIN_CHANNEL_TIMEOUT
@ JOIN_CHANNEL_TIMEOUT
Definition: IAgoraRtmService.h:411
agora::rtm::JOIN_CHANNEL_ERR_EXCEED_LIMIT
@ JOIN_CHANNEL_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:416
agora::rtm::JOIN_CHANNEL_ERR_NOT_INITIALIZED
@ JOIN_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:436
agora::rtm::JOIN_CHANNEL_ERR_INVALID_ARGUMENT
@ JOIN_CHANNEL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:406
agora::rtm::LOG_FILTER_TYPE
LOG_FILTER_TYPE
Output log filter level.
Definition: IAgoraRtmService.h:2242
agora::rtm::LOG_FILTER_ERROR
@ LOG_FILTER_ERROR
Definition: IAgoraRtmService.h:2262
agora::rtm::LOG_FILTER_CRITICAL
@ LOG_FILTER_CRITICAL
Definition: IAgoraRtmService.h:2267
agora::rtm::LOG_FILTER_INFO
@ LOG_FILTER_INFO
Definition: IAgoraRtmService.h:2252
agora::rtm::LOG_FILTER_MASK
@ LOG_FILTER_MASK
Definition: IAgoraRtmService.h:2271
agora::rtm::LOG_FILTER_WARN
@ LOG_FILTER_WARN
Definition: IAgoraRtmService.h:2257
agora::rtm::LOG_FILTER_OFF
@ LOG_FILTER_OFF
Definition: IAgoraRtmService.h:2247
agora::rtm::LOGOUT_ERR_CODE
LOGOUT_ERR_CODE
Error codes related to logout.
Definition: IAgoraRtmService.h:152
agora::rtm::LOGOUT_ERR_OK
@ LOGOUT_ERR_OK
Definition: IAgoraRtmService.h:157
agora::rtm::LOGOUT_ERR_REJECTED
@ LOGOUT_ERR_REJECTED
Definition: IAgoraRtmService.h:162
agora::rtm::LOGOUT_ERR_USER_NOT_LOGGED_IN
@ LOGOUT_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:172
agora::rtm::LOGOUT_ERR_NOT_INITIALIZED
@ LOGOUT_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:167
agora::rtm::CANCEL_MEDIA_ERR_CODE
CANCEL_MEDIA_ERR_CODE
Error codes related to cancelling a download task or cancelling an upload task.
Definition: IAgoraRtmService.h:969
agora::rtm::CANCEL_MEDIA_ERR_NOT_LOGGED_IN
@ CANCEL_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:993
agora::rtm::CANCEL_MEDIA_ERR_NOT_INITIALIZED
@ CANCEL_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:988
agora::rtm::CANCEL_MEDIA_ERR_NOT_EXIST
@ CANCEL_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:983
agora::rtm::CANCEL_MEDIA_ERR_OK
@ CANCEL_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:973
agora::rtm::CANCEL_MEDIA_ERR_FAILURE
@ CANCEL_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:978
agora
Definition: IAgoraRtmCallManager.h:11
agora::rtm::ChannelAttributeOptions
Data structure holding channel attribute-specific options.
Definition: IAgoraRtmService.h:1154
agora::rtm::ChannelAttributeOptions::enableNotificationToChannelMembers
bool enableNotificationToChannelMembers
Definition: IAgoraRtmService.h:1164
agora::rtm::ChannelAttributeOptions::ChannelAttributeOptions
ChannelAttributeOptions()
Definition: IAgoraRtmService.h:1165
agora::rtm::ChannelMemberCount
The data structure holding a channel ID and the current channel member count.
Definition: IAgoraRtmService.h:1514
agora::rtm::ChannelMemberCount::count
int count
Definition: IAgoraRtmService.h:1525
agora::rtm::ChannelMemberCount::channelId
const char * channelId
Definition: IAgoraRtmService.h:1518
agora::rtm::MediaOperationProgress
A data structure representing the upload ratio or download ratio.
Definition: IAgoraRtmService.h:1083
agora::rtm::MediaOperationProgress::totalSize
long long totalSize
Definition: IAgoraRtmService.h:1087
agora::rtm::MediaOperationProgress::currentSize
long long currentSize
Definition: IAgoraRtmService.h:1091
agora::rtm::PeerOnlineStatus
The data structure holding an RTM user and the user's online status.
Definition: IAgoraRtmService.h:1483
agora::rtm::PeerOnlineStatus::peerId
const char * peerId
Definition: IAgoraRtmService.h:1488
agora::rtm::PeerOnlineStatus::onlineState
PEER_ONLINE_STATE onlineState
Definition: IAgoraRtmService.h:1507
agora::rtm::PeerOnlineStatus::isOnline
bool isOnline
Definition: IAgoraRtmService.h:1498
agora::rtm::RtmAttribute
A data structure holding a user attribute key and its value.
Definition: IAgoraRtmService.h:1066
agora::rtm::RtmAttribute::value
const char * value
Definition: IAgoraRtmService.h:1076
agora::rtm::RtmAttribute::key
const char * key
Definition: IAgoraRtmService.h:1071
agora::rtm::RtmServiceContext
Definition: IAgoraRtmService.h:3081
agora::rtm::RtmServiceContext::areaCode
int areaCode
Definition: IAgoraRtmService.h:3085
agora::rtm::RtmServiceContext::proxyType
RTM_CLOUD_PROXY_TYPE proxyType
Definition: IAgoraRtmService.h:3090
agora::rtm::SendMessageOptions
Message sending options.
Definition: IAgoraRtmService.h:1032
agora::rtm::SendMessageOptions::enableHistoricalMessaging
bool enableHistoricalMessaging
Definition: IAgoraRtmService.h:1052
agora::rtm::SendMessageOptions::enableOfflineMessaging
bool enableOfflineMessaging
Definition: IAgoraRtmService.h:1043
agora::rtm::SendMessageOptions::SendMessageOptions
SendMessageOptions()
Definition: IAgoraRtmService.h:1054
Generated by doxygen 1.9.3