Documentation

Real-time Messaging
Console Agora.io Community Submit ticket
English
search-icon

Agora RTM CPP API Reference for Linux & Windows

Overview IRtmService IMessage SendMessageOptions PEER_SUBSCRIPTION_OPTION PeerOnlineStatus RtmAttribute IRtmChannelAttribute ChannelAttributeOptions AgoraRtmChannelMemberCount IChannel IChannelMember IRtmCallManager ILocalCallInvitation IRemoteCallInvitation IRtmServiceEventHandler IChannelEventHandler IRtmCallEventHandler Status Codes & Error Codes
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"
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 };
316
320 enum PEER_MESSAGE_ERR_CODE {
321
325 PEER_MESSAGE_ERR_OK = 0,
326
330 PEER_MESSAGE_ERR_FAILURE = 1,
331
335 PEER_MESSAGE_ERR_SENT_TIMEOUT = 2,
336
340 PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3,
341
345 PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4,
346
350 PEER_MESSAGE_ERR_TOO_OFTEN = 5,
351
355 PEER_MESSAGE_ERR_INVALID_USERID = 6,
356
360 PEER_MESSAGE_ERR_INVALID_MESSAGE = 7,
361
365 PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE = 8,
366
370 PEER_MESSAGE_ERR_NOT_INITIALIZED = 101,
371
375 PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
376 };
377
381 enum JOIN_CHANNEL_ERR {
382
386 JOIN_CHANNEL_ERR_OK = 0,
387
391 JOIN_CHANNEL_ERR_FAILURE = 1,
392
396 JOIN_CHANNEL_ERR_REJECTED = 2, // Usually occurs when the user is already in the channel
397
401 JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3,
402
406 JOIN_CHANNEL_TIMEOUT = 4,
407
411 JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5,
412
416 JOIN_CHANNEL_ERR_ALREADY_JOINED = 6,
417
421 JOIN_CHANNEL_ERR_TOO_OFTEN = 7,
422
426 JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8,
427
431 JOIN_CHANNEL_ERR_NOT_INITIALIZED = 101,
432
436 JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
437 };
438
442 enum LEAVE_CHANNEL_ERR {
443
447 LEAVE_CHANNEL_ERR_OK = 0,
448
452 LEAVE_CHANNEL_ERR_FAILURE = 1,
453
457 LEAVE_CHANNEL_ERR_REJECTED = 2,
458
462 LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL = 3,
463
467 LEAVE_CHANNEL_ERR_NOT_INITIALIZED = 101,
468
472 LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102,
473 };
474
478 enum LEAVE_CHANNEL_REASON {
479
483 LEAVE_CHANNEL_REASON_QUIT = 1,
484
488 LEAVE_CHANNEL_REASON_KICKED = 2,
489 };
490
494 enum CHANNEL_MESSAGE_ERR_CODE {
495
499 CHANNEL_MESSAGE_ERR_OK = 0,
500
504 CHANNEL_MESSAGE_ERR_FAILURE = 1,
505
509 CHANNEL_MESSAGE_ERR_SENT_TIMEOUT = 2,
510
514 CHANNEL_MESSAGE_ERR_TOO_OFTEN = 3,
515
519 CHANNEL_MESSAGE_ERR_INVALID_MESSAGE = 4,
520
524 CHANNEL_MESSAGE_ERR_NOT_INITIALIZED = 101,
525
529 CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102,
530 };
531
535 enum GET_MEMBERS_ERR {
536
540 GET_MEMBERS_ERR_OK = 0,
541
545 GET_MEMBERS_ERR_FAILURE = 1,
546
550 GET_MEMBERS_ERR_REJECTED = 2,
551
555 GET_MEMBERS_ERR_TIMEOUT = 3,
556
560 GET_MEMBERS_ERR_TOO_OFTEN = 4,
561
565 GET_MEMBERS_ERR_NOT_IN_CHANNEL = 5,
566
570 GET_MEMBERS_ERR_NOT_INITIALIZED = 101,
571
575 GET_MEMBERS_ERR_USER_NOT_LOGGED_IN = 102,
576 };
577
581 enum QUERY_PEERS_ONLINE_STATUS_ERR {
582
586 QUERY_PEERS_ONLINE_STATUS_ERR_OK = 0,
587
591 QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE = 1,
592
596 QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT = 2,
597
601 QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED = 3,
602
606 QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT = 4,
607
611 QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN = 5,
612
616 QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED = 101,
617
621 QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
622 };
623
627 enum PEER_ONLINE_STATE {
628
632 PEER_ONLINE_STATE_ONLINE = 0,
633
637 PEER_ONLINE_STATE_UNREACHABLE = 1,
638
642 PEER_ONLINE_STATE_OFFLINE = 2,
643 };
644
648 enum PEER_SUBSCRIPTION_OPTION {
652 PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS = 0,
653 };
654
658 enum PEER_SUBSCRIPTION_STATUS_ERR {
659
663 PEER_SUBSCRIPTION_STATUS_ERR_OK = 0,
664
668 PEER_SUBSCRIPTION_STATUS_ERR_FAILURE = 1,
669
673 PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT = 2,
674
678 PEER_SUBSCRIPTION_STATUS_ERR_REJECTED = 3,
679
683 PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT = 4,
684
688 PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN = 5,
689
693 PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW = 6,
694
698 PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED = 101,
699
703 PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN = 102,
704 };
705
709 enum QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR {
710
714 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK = 0,
715
719 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE = 1,
720
724 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT = 2,
725
729 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN = 3,
730
734 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED = 101,
735
739 QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN = 102,
740 };
741
745 enum ATTRIBUTE_OPERATION_ERR {
746
750 ATTRIBUTE_OPERATION_ERR_OK = 0,
751
755 ATTRIBUTE_OPERATION_ERR_NOT_READY = 1,
756
760 ATTRIBUTE_OPERATION_ERR_FAILURE = 2,
761
765 ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3,
766
773 ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4,
774
783 ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5,
784
788 ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6,
789
793 ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7,
794
798 ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED = 101,
799
803 ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN = 102,
804 };
805
809 enum GET_CHANNEL_MEMBER_COUNT_ERR_CODE {
810
814 GET_CHANNEL_MEMBER_COUNT_ERR_OK = 0,
815
819 GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE = 1,
820
824 GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT = 2,
825
829 GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN = 3,
830
834 GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT = 4,
835
839 GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT = 5,
840
844 GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED = 101,
845
849 GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN = 102,
850 };
851
855 enum DOWNLOAD_MEDIA_ERR_CODE {
859 DOWNLOAD_MEDIA_ERR_OK = 0,
860
864 DOWNLOAD_MEDIA_ERR_FAILURE = 1,
865
869 DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
873 DOWNLOAD_MEDIA_ERR_TIMEOUT = 3,
874
878 DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4,
879
883 DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
884
891 DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6,
892
896 DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
897
901 DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
902 };
903
904
908 enum UPLOAD_MEDIA_ERR_CODE {
912 UPLOAD_MEDIA_ERR_OK = 0,
913
917 UPLOAD_MEDIA_ERR_FAILURE = 1,
918
922 UPLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2,
923
927 UPLOAD_MEDIA_ERR_TIMEOUT = 3,
928
932 UPLOAD_MEDIA_ERR_SIZE_OVERFLOW = 4,
936 UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5,
943 UPLOAD_MEDIA_ERR_INTERRUPTED = 6,
944
948 UPLOAD_MEDIA_ERR_NOT_INITIALIZED = 101,
949
953 UPLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102,
954 };
955
959 enum CANCEL_MEDIA_ERR_CODE {
963 CANCEL_MEDIA_ERR_OK = 0,
964
968 CANCEL_MEDIA_ERR_FAILURE = 1,
969
973 CANCEL_MEDIA_ERR_NOT_EXIST = 2,
974
978 CANCEL_MEDIA_ERR_NOT_INITIALIZED = 101,
979
983 CANCEL_MEDIA_ERR_NOT_LOGGED_IN = 102,
984 };
985
986
987
991 enum MESSAGE_TYPE {
992
996 MESSAGE_TYPE_UNDEFINED = 0,
997
1001 MESSAGE_TYPE_TEXT = 1,
1002
1006 MESSAGE_TYPE_RAW = 2,
1007
1011 MESSAGE_TYPE_FILE = 3,
1012
1016 MESSAGE_TYPE_IMAGE = 4,
1017 };
1018
1022 struct SendMessageOptions{
1033 bool enableOfflineMessaging;
1042 bool enableHistoricalMessaging;
1043
1044 SendMessageOptions()
1045 : enableOfflineMessaging(false)
1046
1047 , enableHistoricalMessaging(false)
1048
1049 {}
1050 };
1051
1055 struct RtmAttribute
1056 {
1057
1061 const char* key;
1062
1066 const char* value;
1067 };
1068
1072 struct MediaOperationProgress
1073 {
1077 long long totalSize;
1081 long long currentSize;
1082 };
1083
1087 class IRtmChannelAttribute
1088 {
1089 protected:
1090 virtual ~IRtmChannelAttribute() {}
1091 public:
1092
1098 virtual void setKey(const char *key) = 0;
1099
1105 virtual const char *getKey() const = 0;
1106
1112 virtual void setValue(const char *value) = 0;
1113
1119 virtual const char *getValue() const = 0;
1120
1126 virtual const char *getLastUpdateUserId() const = 0;
1127
1133 virtual long long getLastUpdateTs() const = 0;
1134
1138 virtual void release() = 0;
1139 };
1140
1144 struct ChannelAttributeOptions{
1145
1154 bool enableNotificationToChannelMembers;
1155 ChannelAttributeOptions():enableNotificationToChannelMembers(false){}
1156 };
1157
1161 class IMessage
1162 {
1163 protected:
1164 virtual ~IMessage() {}
1165 public:
1166
1172 virtual long long getMessageId() const = 0;
1173
1179 virtual MESSAGE_TYPE getMessageType() const = 0;
1180
1186 virtual void setText(const char *str) = 0;
1187
1193 virtual const char *getText() const = 0;
1194
1200 virtual const char *getRawMessageData() const = 0;
1201
1207 virtual int getRawMessageLength() const = 0;
1218 virtual long long getServerReceivedTs() const = 0;
1219
1231 virtual bool isOfflineMessage() const = 0;
1232
1238 virtual void release() = 0;
1239 };
1240
1244 class IFileMessage : public IMessage
1245 {
1246 public:
1247
1253 virtual long long getSize() const = 0;
1254
1264 virtual const char* getMediaId() const = 0;
1265
1272 virtual void setThumbnail(const uint8_t* thumbnail, int length) = 0;
1273
1279 virtual const char* getThumbnailData() const = 0;
1280
1286 virtual const long long getThumbnailLength() const = 0;
1287
1293 virtual void setFileName(const char* fileName) = 0;
1294
1300 virtual const char* getFileName() const = 0;
1301 };
1302
1306 class IImageMessage : public IMessage
1307 {
1308 public:
1314 virtual long long getSize() const = 0;
1315
1325 virtual const char* getMediaId() const = 0;
1326
1333 virtual void setThumbnail(const uint8_t* thumbnail, long long length) = 0;
1334
1340 virtual const char* getThumbnailData() const = 0;
1341
1347 virtual const long long getThumbnailLength() const = 0;
1348
1354 virtual void setFileName(const char* fileName) = 0;
1355
1361 virtual const char* getFileName() const = 0;
1362
1372 virtual void setWidth(int width) = 0;
1373
1383 virtual int getWidth() const = 0;
1384
1394 virtual void setHeight(int height) = 0;
1395
1405 virtual int getHeight() const = 0;
1406
1414 virtual void setThumbnailWidth(int width) = 0;
1415
1421 virtual int getThumbnailWidth() const = 0;
1422
1430 virtual void setThumbnailHeight(int height) = 0;
1431
1437 virtual int getThumbnailHeight() const = 0;
1438 };
1439
1443 class IChannelMember
1444 {
1445 protected:
1446 virtual ~IChannelMember() {}
1447 public:
1448
1454 virtual const char * getUserId() const = 0;
1455
1461 virtual const char * getChannelId() const = 0;
1462
1466 virtual void release() = 0;
1467 };
1468
1472 struct PeerOnlineStatus
1473 {
1474
1478 const char* peerId;
1479
1488 bool isOnline;
1489
1497 PEER_ONLINE_STATE onlineState;
1498 };
1499
1503 struct ChannelMemberCount
1504 {
1508 const char* channelId;
1509 // count of channel, 0 if channel not found.
1515 int count;
1516 };
1517
1521 class IChannelEventHandler
1522 {
1523 public:
1524
1525 virtual ~IChannelEventHandler()
1526 {
1527 }
1528
1536 virtual void onJoinSuccess()
1537 {
1538 }
1539
1547 virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
1548 {
1549 (JOIN_CHANNEL_ERR) errorCode;
1550 }
1551
1557 virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
1558 {
1559 (LEAVE_CHANNEL_ERR) errorCode;
1560 }
1561
1568 virtual void onMessageReceived(const char *userId, const IMessage *message)
1569 {
1570 (const char *) userId;
1571 (IMessage *) message;
1572 }
1581 virtual void onImageMessageReceived(const char *userId, const IImageMessage* message)
1582 {
1583 (IImageMessage *) message;
1584 }
1585
1594 virtual void onFileMessageReceived(const char *userId, const IFileMessage* message)
1595 {
1596 (IFileMessage *) message;
1597 }
1598
1605 virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
1606 {
1607 (long long) messageId;
1608 (CHANNEL_MESSAGE_ERR_CODE) state;
1609 }
1610
1620 virtual void onMemberJoined(IChannelMember *member)
1621 {
1622 (IChannelMember *) member;
1623 }
1624
1634 virtual void onMemberLeft(IChannelMember *member)
1635 {
1636 (IChannelMember *) member;
1637 }
1638
1648 virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
1649 {
1650 (IChannelMember **) members;
1651 (int) userCount;
1652 }
1653
1662 virtual void onAttributesUpdated(const IRtmChannelAttribute* attributes[], int numberOfAttributes)
1663 {
1664 (const IRtmChannelAttribute**) attributes;
1665 (int) numberOfAttributes;
1666 }
1667
1678 virtual void onMemberCountUpdated(int memberCount)
1679 {
1680 (int) memberCount;
1681 }
1682 };
1683
1687 class IChannel
1688 {
1689 protected:
1690 virtual ~IChannel() {}
1691 public:
1692// virtual void setEventHandler(IChannelEventHandler *eventHandler) = 0;
1693
1707 virtual int join() = 0;
1708
1720 virtual int leave() = 0;
1721
1738 virtual int sendMessage(const IMessage *message) = 0;
1739
1755 virtual int sendMessage(const IMessage *message, const SendMessageOptions &options) = 0;
1756
1762 virtual const char *getId() const = 0;
1763
1775 virtual int getMembers() = 0;
1776
1777 // sync_call
1778
1782 virtual void release() = 0;
1783 };
1784
1785 class IRtmServiceEventHandler
1786 {
1787 public:
1788 virtual ~IRtmServiceEventHandler()
1789 {
1790 }
1791
1797 virtual void onLoginSuccess() {}
1798
1804 virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
1805 {
1806 (LOGIN_ERR_CODE) errorCode;
1807 }
1808
1815 virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERR_CODE errorCode)
1816 {
1817 (const char*) token;
1818 (RENEW_TOKEN_ERR_CODE) errorCode;
1819 }
1820
1827 virtual void onTokenExpired()
1828 {
1829 }
1830
1836 virtual void onLogout(LOGOUT_ERR_CODE errorCode)
1837 {
1838 (LOGOUT_ERR_CODE) errorCode;
1839 }
1840
1847 virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
1848 {
1849 }
1850
1858 virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
1859 {
1860 (long long) messageId;
1861 (PEER_MESSAGE_ERR_CODE) errorCode;
1862 }
1863
1870 virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
1871 {
1872 (char *) peerId;
1873 (IMessage *) message;
1874 }
1875
1884 virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage* message)
1885 {
1886 (char *) peerId;
1887 (IImageMessage *) message;
1888 }
1889
1898 virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage* message)
1899 {
1900 (char *) peerId;
1901 (IFileMessage *) message;
1902 }
1903
1916 virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
1917 {
1918 (long long) requestId;
1919 (MediaOperationProgress) progress;
1920 }
1921
1934 virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
1935 {
1936 (long long) requestId;
1937 (MediaOperationProgress) progress;
1938 }
1939
1947 virtual void onFileMediaUploadResult(long long requestId, IFileMessage* fileMessage, UPLOAD_MEDIA_ERR_CODE code)
1948 {
1949 (long long) requestId;
1950 (IFileMessage *) fileMessage;
1951 (UPLOAD_MEDIA_ERR_CODE) code;
1952 }
1953
1961 virtual void onImageMediaUploadResult(long long requestId, IImageMessage* imageMessage, UPLOAD_MEDIA_ERR_CODE code)
1962 {
1963 (long long) requestId;
1964 (IImageMessage *) imageMessage;
1965 (UPLOAD_MEDIA_ERR_CODE) code;
1966 }
1967
1974 virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
1975 {
1976 (long long)requestId;
1977 (DOWNLOAD_MEDIA_ERR_CODE)code;
1978 }
1979
1990 virtual void onMediaDownloadToMemoryResult(long long requestId, const char* memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
1991 {
1992 (long long) requestId;
1993 (const char*) memory;
1994 (long long) length;
1995 (DOWNLOAD_MEDIA_ERR_CODE) code;
1996 }
1997
2004 virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
2005 {
2006 (long long) requestId;
2007 (CANCEL_MEDIA_ERR_CODE) code;
2008 }
2009
2018 virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus* peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
2019 {
2020 (long long) requestId;
2021 (const PeerOnlineStatus*) peersStatus;
2022 (int) peerCount;
2023 (QUERY_PEERS_ONLINE_STATUS_ERR) errorCode;
2024 }
2025
2032 virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
2033 {
2034 (long long)requestId;
2035 (PEER_SUBSCRIPTION_STATUS_ERR)errorCode;
2036 }
2037
2046 virtual void onQueryPeersBySubscriptionOptionResult(long long requestId, const char* peerIds[], int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode)
2047 {
2048 (const char**)peerIds;
2049 (int)peerCount;
2050 (QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR)errorCode;
2051 }
2052
2063 virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
2064 {
2065 (const PeerOnlineStatus*)peersStatus;
2066 (int)peerCount;
2067 }
2068
2075 virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2076 {
2077 (long long) requestId;
2078 (ATTRIBUTE_OPERATION_ERR) errorCode;
2079 }
2080
2087 virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2088 {
2089 (long long) requestId;
2090 (ATTRIBUTE_OPERATION_ERR) errorCode;
2091 }
2092
2099 virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2100 {
2101 (long long) requestId;
2102 (ATTRIBUTE_OPERATION_ERR) errorCode;
2103 }
2104
2111 virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2112 {
2113 (long long) requestId;
2114 (ATTRIBUTE_OPERATION_ERR) errorCode;
2115 }
2116
2126 virtual void onGetUserAttributesResult(long long requestId, const char* userId, const RtmAttribute* attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2127 {
2128 (long long) requestId;
2129 (const RtmAttribute*) attributes;
2130 (int) numberOfAttributes;
2131 (ATTRIBUTE_OPERATION_ERR) errorCode;
2132 }
2133
2140 virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2141 {
2142 (long long) requestId;
2143 (ATTRIBUTE_OPERATION_ERR) errorCode;
2144 }
2145
2152 virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2153 {
2154 (long long) requestId;
2155 (ATTRIBUTE_OPERATION_ERR) errorCode;
2156 }
2157
2164 virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2165 {
2166 (long long) requestId;
2167 (ATTRIBUTE_OPERATION_ERR) errorCode;
2168 }
2169
2176 virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
2177 {
2178 (long long) requestId;
2179 (ATTRIBUTE_OPERATION_ERR) errorCode;
2180 }
2181
2190 virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
2191 {
2192// (long long) requestId;
2193// (const IRtmChannelAttribute**) attributes;
2194// (int) numberOfAttributes;
2195// (ATTRIBUTE_OPERATION_ERR) errorCode;
2196 }
2197
2206 virtual void onGetChannelMemberCountResult(long long requestId, const ChannelMemberCount* channelMemberCounts , int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode)
2207 {
2208 (long long) requestId;
2209 (const ChannelMemberCount*) channelMemberCounts;
2210 (int) channelCount;
2211 (GET_CHANNEL_MEMBER_COUNT_ERR_CODE)errorCode;
2212 }
2213 };
2214
2215 class IRtmCallManager;
2216 class IRtmCallEventHandler;
2217
2221 enum LOG_FILTER_TYPE
2222 {
2223
2227 LOG_FILTER_OFF = 0,
2228
2232 LOG_FILTER_INFO = 0x000f,
2233
2237 LOG_FILTER_WARN = 0x000e,
2238
2242 LOG_FILTER_ERROR = 0x000c,
2243
2247 LOG_FILTER_CRITICAL = 0x0008,
2251 LOG_FILTER_MASK = 0x80f,
2252 };
2253
2254 class IRtmService
2255 {
2256 protected:
2257 virtual ~IRtmService() {}
2258 public:
2259
2271 virtual int initialize(const char *appId, IRtmServiceEventHandler *eventHandler) = 0;
2272
2278 virtual void addEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2279
2285 virtual void removeEventHandler(IRtmServiceEventHandler *eventHandler) = 0;
2286
2290 virtual void release(bool sync = false) = 0;
2291
2321 virtual int login(const char *token, const char *userId) = 0;
2322
2332 virtual int logout() = 0;
2333
2344 virtual int renewToken(const char* token) = 0;
2345
2359 virtual int sendMessageToPeer(const char *peerId, const IMessage *message) = 0;
2360
2378 virtual int downloadMediaToMemory(const char* mediaId, long long &requestId) = 0;
2379
2394 virtual int downloadMediaToFile(const char* mediaId, const char* filePath, long long &requestId) = 0;
2395
2411 virtual int cancelMediaDownload(long long requestId) = 0;
2412
2428 virtual int cancelMediaUpload(long long requestId) = 0;
2429
2430
2457 virtual int sendMessageToPeer(const char *peerId, const IMessage *message, const SendMessageOptions &options) = 0;
2458
2479 virtual IChannel * createChannel(const char *channelId, IChannelEventHandler *eventHandler) = 0;
2480
2491 virtual IRtmCallManager* getRtmCallManager(IRtmCallEventHandler*eventHandler) = 0;
2492
2503 virtual IMessage *createMessage() = 0;
2504
2516 virtual IMessage *createMessage(const char* message) = 0;
2517
2531 virtual IMessage *createMessage(const uint8_t* rawData, int length) = 0;
2532
2547 virtual IMessage *createMessage(const uint8_t* rawData, int length, const char* description) = 0;
2548
2560 virtual IFileMessage *createFileMessageByMediaId(const char* mediaId) = 0;
2561
2573 virtual IImageMessage *createImageMessageByMediaId(const char* mediaId) = 0;
2574
2593 virtual int createFileMessageByUploading(const char* filePath, long long &requestId) = 0;
2594
2615 virtual int createImageMessageByUploading(const char* filePath, long long &requestId) = 0;
2616
2622 virtual IRtmChannelAttribute *createChannelAttribute() = 0;
2623
2634 virtual int setParameters(const char* parameters) = 0;
2635// virtual int getParameters(const char* key, any_document_t& result) = 0;
2636
2652 virtual int queryPeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2653
2674 virtual int subscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2675
2688 virtual int unsubscribePeersOnlineStatus(const char* peerIds[], int peerCount, long long &requestId) = 0;
2689
2701 virtual int queryPeersBySubscriptionOption(PEER_SUBSCRIPTION_OPTION option, long long &requestId) = 0;
2702
2717 virtual int setLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2718
2735 virtual int addOrUpdateLocalUserAttributes(const RtmAttribute* attributes, int numberOfAttributes, long long &requestId) = 0;
2736
2751 virtual int deleteLocalUserAttributesByKeys(const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2752
2765 virtual int clearLocalUserAttributes(long long &requestId) = 0;
2766
2780 virtual int getUserAttributes(const char* userId, long long &requestId) = 0;
2781
2797 virtual int getUserAttributesByKeys(const char* userId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2798
2819 virtual int setChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2820
2843 virtual int addOrUpdateChannelAttributes(const char* channelId, const IRtmChannelAttribute* attributes[], int numberOfAttributes, const ChannelAttributeOptions &options, long long &requestId) = 0;
2844
2865 virtual int deleteChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, const ChannelAttributeOptions &options, long long &requestId) = 0;
2866
2884 virtual int clearChannelAttributes(const char* channelId, const ChannelAttributeOptions &options, long long &requestId) = 0;
2885
2901 virtual int getChannelAttributes(const char* channelId, long long &requestId) = 0;
2902
2919 virtual int getChannelAttributesByKeys(const char* channelId, const char* attributeKeys[], int numberOfKeys, long long &requestId) = 0;
2920
2938 virtual int getChannelMemberCount(const char* channelIds[], int channelCount, long long &requestId) = 0;
2939
2953 virtual int setLogFile(const char* logfile) = 0;
2954
2965 virtual int setLogFilter(LOG_FILTER_TYPE filter) = 0;
2966
2975 virtual int setLogFileSize(int fileSizeInKBytes) = 0;
2976 };
2978
2982
2990AGORA_API IRtmService* AGORA_CALL createRtmService();
2991
2993
2995
2997
3001
3007AGORA_API const char* AGORA_CALL getRtmSdkVersion();
3008
3009#ifndef AGORA_SDK_BOTH_RTM_AND_RTC
3013enum RTM_AREA_CODE {
3017 AREA_CODE_CN = (1 << 0),
3021 AREA_CODE_NA = (1 << 1),
3025 AREA_CODE_EU = (1 << 2),
3029 AREA_CODE_AS = (1 << 3),
3033 AREA_CODE_JP = (1 << 4),
3037 AREA_CODE_IN = (1 << 5),
3041 AREA_CODE_GLOB = (0xFFFFFFFF)
3042};
3043#endif //AGORA_SDK_BOTH_RTM_AND_RTC
3044
3045/* Type of the cloud proxy. */
3046enum RTM_CLOUD_PROXY_TYPE {
3050 RTM_NONE_PROXY = 0,
3054 RTM_TCP_PROXY = 1
3055};
3056
3060struct RtmServiceContext
3061{
3065 int areaCode = AREA_CODE_GLOB;
3066
3070 RTM_CLOUD_PROXY_TYPE proxyType = RTM_NONE_PROXY;
3071};
3072
3076enum SET_RTM_SERVICE_CONTEXT_ERR_CODE
3077{
3081 SET_RTM_SERVICE_CONTEXT_ERR_OK = 0,
3085 SET_RTM_SERVICE_CONTEXT_ERR_FAILURE = 1,
3086};
3087
3097AGORA_API SET_RTM_SERVICE_CONTEXT_ERR_CODE AGORA_CALL setRtmServiceContext(const RtmServiceContext& context);
3098
3100
3102 }
3103}
agora::rtm::IChannelEventHandler
Callbacks for the Agora RTM channel methods.
Definition: IAgoraRtmService.h:1522
agora::rtm::IChannelEventHandler::onJoinSuccess
virtual void onJoinSuccess()
Definition: IAgoraRtmService.h:1536
agora::rtm::IChannelEventHandler::onFileMessageReceived
virtual void onFileMessageReceived(const char *userId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1594
agora::rtm::IChannelEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, CHANNEL_MESSAGE_ERR_CODE state)
Definition: IAgoraRtmService.h:1605
agora::rtm::IChannelEventHandler::onMemberJoined
virtual void onMemberJoined(IChannelMember *member)
Definition: IAgoraRtmService.h:1620
agora::rtm::IChannelEventHandler::onGetMembers
virtual void onGetMembers(IChannelMember **members, int userCount, GET_MEMBERS_ERR errorCode)
Definition: IAgoraRtmService.h:1648
agora::rtm::IChannelEventHandler::onImageMessageReceived
virtual void onImageMessageReceived(const char *userId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1581
agora::rtm::IChannelEventHandler::onAttributesUpdated
virtual void onAttributesUpdated(const IRtmChannelAttribute *attributes[], int numberOfAttributes)
Definition: IAgoraRtmService.h:1662
agora::rtm::IChannelEventHandler::onMessageReceived
virtual void onMessageReceived(const char *userId, const IMessage *message)
Definition: IAgoraRtmService.h:1568
agora::rtm::IChannelEventHandler::~IChannelEventHandler
virtual ~IChannelEventHandler()
Definition: IAgoraRtmService.h:1525
agora::rtm::IChannelEventHandler::onLeave
virtual void onLeave(LEAVE_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1557
agora::rtm::IChannelEventHandler::onMemberLeft
virtual void onMemberLeft(IChannelMember *member)
Definition: IAgoraRtmService.h:1634
agora::rtm::IChannelEventHandler::onJoinFailure
virtual void onJoinFailure(JOIN_CHANNEL_ERR errorCode)
Definition: IAgoraRtmService.h:1547
agora::rtm::IChannelEventHandler::onMemberCountUpdated
virtual void onMemberCountUpdated(int memberCount)
Definition: IAgoraRtmService.h:1678
agora::rtm::IChannel
Agora RTM channel methods.
Definition: IAgoraRtmService.h:1688
agora::rtm::IChannel::sendMessage
virtual int sendMessage(const IMessage *message, const SendMessageOptions &options)=0
agora::rtm::IChannel::~IChannel
virtual ~IChannel()
Definition: IAgoraRtmService.h:1690
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:1444
agora::rtm::IChannelMember::~IChannelMember
virtual ~IChannelMember()
Definition: IAgoraRtmService.h:1446
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:1245
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:1307
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:1162
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:1164
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:1088
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:1090
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:1786
agora::rtm::IRtmServiceEventHandler::onDeleteChannelAttributesResult
virtual void onDeleteChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2164
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToFileResult
virtual void onMediaDownloadToFileResult(long long requestId, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1974
agora::rtm::IRtmServiceEventHandler::onClearChannelAttributesResult
virtual void onClearChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2176
agora::rtm::IRtmServiceEventHandler::onPeersOnlineStatusChanged
virtual void onPeersOnlineStatusChanged(const PeerOnlineStatus peersStatus[], int peerCount)
Definition: IAgoraRtmService.h:2063
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateChannelAttributesResult
virtual void onAddOrUpdateChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2152
agora::rtm::IRtmServiceEventHandler::onImageMessageReceivedFromPeer
virtual void onImageMessageReceivedFromPeer(const char *peerId, const IImageMessage *message)
Definition: IAgoraRtmService.h:1884
agora::rtm::IRtmServiceEventHandler::onDeleteLocalUserAttributesResult
virtual void onDeleteLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2099
agora::rtm::IRtmServiceEventHandler::onLoginFailure
virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1804
agora::rtm::IRtmServiceEventHandler::onFileMessageReceivedFromPeer
virtual void onFileMessageReceivedFromPeer(const char *peerId, const IFileMessage *message)
Definition: IAgoraRtmService.h:1898
agora::rtm::IRtmServiceEventHandler::onSendMessageResult
virtual void onSendMessageResult(long long messageId, PEER_MESSAGE_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1858
agora::rtm::IRtmServiceEventHandler::onMediaUploadingProgress
virtual void onMediaUploadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1916
agora::rtm::IRtmServiceEventHandler::onLogout
virtual void onLogout(LOGOUT_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1836
agora::rtm::IRtmServiceEventHandler::onMediaCancelResult
virtual void onMediaCancelResult(long long requestId, CANCEL_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:2004
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:2126
agora::rtm::IRtmServiceEventHandler::onTokenExpired
virtual void onTokenExpired()
Definition: IAgoraRtmService.h:1827
agora::rtm::IRtmServiceEventHandler::onQueryPeersOnlineStatusResult
virtual void onQueryPeersOnlineStatusResult(long long requestId, const PeerOnlineStatus *peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2018
agora::rtm::IRtmServiceEventHandler::onSetChannelAttributesResult
virtual void onSetChannelAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2140
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:2206
agora::rtm::IRtmServiceEventHandler::onLoginSuccess
virtual void onLoginSuccess()
Definition: IAgoraRtmService.h:1797
agora::rtm::IRtmServiceEventHandler::~IRtmServiceEventHandler
virtual ~IRtmServiceEventHandler()
Definition: IAgoraRtmService.h:1788
agora::rtm::IRtmServiceEventHandler::onClearLocalUserAttributesResult
virtual void onClearLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2111
agora::rtm::IRtmServiceEventHandler::onRenewTokenResult
virtual void onRenewTokenResult(const char *token, RENEW_TOKEN_ERR_CODE errorCode)
Definition: IAgoraRtmService.h:1815
agora::rtm::IRtmServiceEventHandler::onMediaDownloadingProgress
virtual void onMediaDownloadingProgress(long long requestId, const MediaOperationProgress &progress)
Definition: IAgoraRtmService.h:1934
agora::rtm::IRtmServiceEventHandler::onConnectionStateChanged
virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
Definition: IAgoraRtmService.h:1847
agora::rtm::IRtmServiceEventHandler::onFileMediaUploadResult
virtual void onFileMediaUploadResult(long long requestId, IFileMessage *fileMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1947
agora::rtm::IRtmServiceEventHandler::onAddOrUpdateLocalUserAttributesResult
virtual void onAddOrUpdateLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2087
agora::rtm::IRtmServiceEventHandler::onGetChannelAttributesResult
virtual void onGetChannelAttributesResult(long long requestId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2190
agora::rtm::IRtmServiceEventHandler::onImageMediaUploadResult
virtual void onImageMediaUploadResult(long long requestId, IImageMessage *imageMessage, UPLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1961
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:2046
agora::rtm::IRtmServiceEventHandler::onSetLocalUserAttributesResult
virtual void onSetLocalUserAttributesResult(long long requestId, ATTRIBUTE_OPERATION_ERR errorCode)
Definition: IAgoraRtmService.h:2075
agora::rtm::IRtmServiceEventHandler::onMediaDownloadToMemoryResult
virtual void onMediaDownloadToMemoryResult(long long requestId, const char *memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code)
Definition: IAgoraRtmService.h:1990
agora::rtm::IRtmServiceEventHandler::onSubscriptionRequestResult
virtual void onSubscriptionRequestResult(long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode)
Definition: IAgoraRtmService.h:2032
agora::rtm::IRtmServiceEventHandler::onMessageReceivedFromPeer
virtual void onMessageReceivedFromPeer(const char *peerId, const IMessage *message)
Definition: IAgoraRtmService.h:1870
agora::rtm::IRtmService
Definition: IAgoraRtmService.h:2255
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:2257
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:3013
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:3046
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_CODE
SET_RTM_SERVICE_CONTEXT_ERR_CODE
Definition: IAgoraRtmService.h:3077
agora::rtm::AREA_CODE_IN
@ AREA_CODE_IN
Definition: IAgoraRtmService.h:3037
agora::rtm::AREA_CODE_JP
@ AREA_CODE_JP
Definition: IAgoraRtmService.h:3033
agora::rtm::AREA_CODE_GLOB
@ AREA_CODE_GLOB
Definition: IAgoraRtmService.h:3041
agora::rtm::AREA_CODE_CN
@ AREA_CODE_CN
Definition: IAgoraRtmService.h:3017
agora::rtm::AREA_CODE_AS
@ AREA_CODE_AS
Definition: IAgoraRtmService.h:3029
agora::rtm::AREA_CODE_NA
@ AREA_CODE_NA
Definition: IAgoraRtmService.h:3021
agora::rtm::AREA_CODE_EU
@ AREA_CODE_EU
Definition: IAgoraRtmService.h:3025
agora::rtm::RTM_NONE_PROXY
@ RTM_NONE_PROXY
Definition: IAgoraRtmService.h:3050
agora::rtm::RTM_TCP_PROXY
@ RTM_TCP_PROXY
Definition: IAgoraRtmService.h:3054
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_OK
@ SET_RTM_SERVICE_CONTEXT_ERR_OK
Definition: IAgoraRtmService.h:3081
agora::rtm::SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
@ SET_RTM_SERVICE_CONTEXT_ERR_FAILURE
Definition: IAgoraRtmService.h:3085
agora::rtm::LEAVE_CHANNEL_REASON
LEAVE_CHANNEL_REASON
Reasons why a user leaves the channel.
Definition: IAgoraRtmService.h:478
agora::rtm::LEAVE_CHANNEL_REASON_QUIT
@ LEAVE_CHANNEL_REASON_QUIT
Definition: IAgoraRtmService.h:483
agora::rtm::LEAVE_CHANNEL_REASON_KICKED
@ LEAVE_CHANNEL_REASON_KICKED
Definition: IAgoraRtmService.h:488
agora::rtm::PEER_ONLINE_STATE
PEER_ONLINE_STATE
The online states of a peer.
Definition: IAgoraRtmService.h:627
agora::rtm::PEER_ONLINE_STATE_UNREACHABLE
@ PEER_ONLINE_STATE_UNREACHABLE
Definition: IAgoraRtmService.h:637
agora::rtm::PEER_ONLINE_STATE_ONLINE
@ PEER_ONLINE_STATE_ONLINE
Definition: IAgoraRtmService.h:632
agora::rtm::PEER_ONLINE_STATE_OFFLINE
@ PEER_ONLINE_STATE_OFFLINE
Definition: IAgoraRtmService.h:642
agora::rtm::DOWNLOAD_MEDIA_ERR_CODE
DOWNLOAD_MEDIA_ERR_CODE
Error codes related to downloading a file or image.
Definition: IAgoraRtmService.h:855
agora::rtm::DOWNLOAD_MEDIA_ERR_FAILURE
@ DOWNLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:864
agora::rtm::DOWNLOAD_MEDIA_ERR_INTERRUPTED
@ DOWNLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:891
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
@ DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:896
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_EXIST
@ DOWNLOAD_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:878
agora::rtm::DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:869
agora::rtm::DOWNLOAD_MEDIA_ERR_TIMEOUT
@ DOWNLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:873
agora::rtm::DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:883
agora::rtm::DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:901
agora::rtm::DOWNLOAD_MEDIA_ERR_OK
@ DOWNLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:859
agora::rtm::PEER_SUBSCRIPTION_OPTION
PEER_SUBSCRIPTION_OPTION
Subscription types.
Definition: IAgoraRtmService.h:648
agora::rtm::PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
@ PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS
Definition: IAgoraRtmService.h:652
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:658
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OK
@ PEER_SUBSCRIPTION_STATUS_ERR_OK
Definition: IAgoraRtmService.h:663
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
@ PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:688
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
@ PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:673
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
@ PEER_SUBSCRIPTION_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:668
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
@ PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:703
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
@ PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW
Definition: IAgoraRtmService.h:693
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
@ PEER_SUBSCRIPTION_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:698
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
@ PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:683
agora::rtm::PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
@ PEER_SUBSCRIPTION_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:678
agora::rtm::MESSAGE_TYPE
MESSAGE_TYPE
Message types.
Definition: IAgoraRtmService.h:991
agora::rtm::MESSAGE_TYPE_RAW
@ MESSAGE_TYPE_RAW
Definition: IAgoraRtmService.h:1006
agora::rtm::MESSAGE_TYPE_FILE
@ MESSAGE_TYPE_FILE
Definition: IAgoraRtmService.h:1011
agora::rtm::MESSAGE_TYPE_UNDEFINED
@ MESSAGE_TYPE_UNDEFINED
Definition: IAgoraRtmService.h:996
agora::rtm::MESSAGE_TYPE_IMAGE
@ MESSAGE_TYPE_IMAGE
Definition: IAgoraRtmService.h:1016
agora::rtm::MESSAGE_TYPE_TEXT
@ MESSAGE_TYPE_TEXT
Definition: IAgoraRtmService.h:1001
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:709
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:729
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE
Definition: IAgoraRtmService.h:719
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:734
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:739
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK
Definition: IAgoraRtmService.h:714
agora::rtm::QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
@ QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:724
agora::rtm::UPLOAD_MEDIA_ERR_CODE
UPLOAD_MEDIA_ERR_CODE
Error codes related to uploading a file or image.
Definition: IAgoraRtmService.h:908
agora::rtm::UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
@ UPLOAD_MEDIA_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:922
agora::rtm::UPLOAD_MEDIA_ERR_OK
@ UPLOAD_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:912
agora::rtm::UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
@ UPLOAD_MEDIA_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:932
agora::rtm::UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
@ UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED
Definition: IAgoraRtmService.h:936
agora::rtm::UPLOAD_MEDIA_ERR_INTERRUPTED
@ UPLOAD_MEDIA_ERR_INTERRUPTED
Definition: IAgoraRtmService.h:943
agora::rtm::UPLOAD_MEDIA_ERR_TIMEOUT
@ UPLOAD_MEDIA_ERR_TIMEOUT
Definition: IAgoraRtmService.h:927
agora::rtm::UPLOAD_MEDIA_ERR_FAILURE
@ UPLOAD_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:917
agora::rtm::UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
@ UPLOAD_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:953
agora::rtm::UPLOAD_MEDIA_ERR_NOT_INITIALIZED
@ UPLOAD_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:948
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:581
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
@ QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE
Definition: IAgoraRtmService.h:591
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
@ QUERY_PEERS_ONLINE_STATUS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:616
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
@ QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:611
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
@ QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:621
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
@ QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED
Definition: IAgoraRtmService.h:601
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
@ QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:596
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
@ QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:606
agora::rtm::QUERY_PEERS_ONLINE_STATUS_ERR_OK
@ QUERY_PEERS_ONLINE_STATUS_ERR_OK
Definition: IAgoraRtmService.h:586
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::GET_MEMBERS_ERR
GET_MEMBERS_ERR
Error codes related to retrieving a channel member list.
Definition: IAgoraRtmService.h:535
agora::rtm::GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
@ GET_MEMBERS_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:575
agora::rtm::GET_MEMBERS_ERR_NOT_IN_CHANNEL
@ GET_MEMBERS_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:565
agora::rtm::GET_MEMBERS_ERR_REJECTED
@ GET_MEMBERS_ERR_REJECTED
Definition: IAgoraRtmService.h:550
agora::rtm::GET_MEMBERS_ERR_FAILURE
@ GET_MEMBERS_ERR_FAILURE
Definition: IAgoraRtmService.h:545
agora::rtm::GET_MEMBERS_ERR_NOT_INITIALIZED
@ GET_MEMBERS_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:570
agora::rtm::GET_MEMBERS_ERR_OK
@ GET_MEMBERS_ERR_OK
Definition: IAgoraRtmService.h:540
agora::rtm::GET_MEMBERS_ERR_TIMEOUT
@ GET_MEMBERS_ERR_TIMEOUT
Definition: IAgoraRtmService.h:555
agora::rtm::GET_MEMBERS_ERR_TOO_OFTEN
@ GET_MEMBERS_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:560
agora::rtm::ATTRIBUTE_OPERATION_ERR
ATTRIBUTE_OPERATION_ERR
Error codes related to attrubute operations.
Definition: IAgoraRtmService.h:745
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND
Definition: IAgoraRtmService.h:788
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
@ ATTRIBUTE_OPERATION_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:798
agora::rtm::ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
@ ATTRIBUTE_OPERATION_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:783
agora::rtm::ATTRIBUTE_OPERATION_ERR_OK
@ ATTRIBUTE_OPERATION_ERR_OK
Definition: IAgoraRtmService.h:750
agora::rtm::ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
@ ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:803
agora::rtm::ATTRIBUTE_OPERATION_ERR_TIMEOUT
@ ATTRIBUTE_OPERATION_ERR_TIMEOUT
Definition: IAgoraRtmService.h:793
agora::rtm::ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
@ ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:765
agora::rtm::ATTRIBUTE_OPERATION_ERR_NOT_READY
@ ATTRIBUTE_OPERATION_ERR_NOT_READY
Definition: IAgoraRtmService.h:755
agora::rtm::ATTRIBUTE_OPERATION_ERR_FAILURE
@ ATTRIBUTE_OPERATION_ERR_FAILURE
Definition: IAgoraRtmService.h:760
agora::rtm::ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
@ ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW
Definition: IAgoraRtmService.h:773
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:494
agora::rtm::CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
@ CHANNEL_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:524
agora::rtm::CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:529
agora::rtm::CHANNEL_MESSAGE_ERR_FAILURE
@ CHANNEL_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:504
agora::rtm::CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
@ CHANNEL_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:509
agora::rtm::CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
@ CHANNEL_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:519
agora::rtm::CHANNEL_MESSAGE_ERR_TOO_OFTEN
@ CHANNEL_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:514
agora::rtm::CHANNEL_MESSAGE_ERR_OK
@ CHANNEL_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:499
agora::rtm::PEER_MESSAGE_ERR_CODE
PEER_MESSAGE_ERR_CODE
Error codes related to sending a peer-to-peer message.
Definition: IAgoraRtmService.h:320
agora::rtm::PEER_MESSAGE_ERR_SENT_TIMEOUT
@ PEER_MESSAGE_ERR_SENT_TIMEOUT
Definition: IAgoraRtmService.h:335
agora::rtm::PEER_MESSAGE_ERR_FAILURE
@ PEER_MESSAGE_ERR_FAILURE
Definition: IAgoraRtmService.h:330
agora::rtm::PEER_MESSAGE_ERR_INVALID_MESSAGE
@ PEER_MESSAGE_ERR_INVALID_MESSAGE
Definition: IAgoraRtmService.h:360
agora::rtm::PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
@ PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE
Definition: IAgoraRtmService.h:365
agora::rtm::PEER_MESSAGE_ERR_NOT_INITIALIZED
@ PEER_MESSAGE_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:370
agora::rtm::PEER_MESSAGE_ERR_PEER_UNREACHABLE
@ PEER_MESSAGE_ERR_PEER_UNREACHABLE
Definition: IAgoraRtmService.h:340
agora::rtm::PEER_MESSAGE_ERR_INVALID_USERID
@ PEER_MESSAGE_ERR_INVALID_USERID
Definition: IAgoraRtmService.h:355
agora::rtm::PEER_MESSAGE_ERR_CACHED_BY_SERVER
@ PEER_MESSAGE_ERR_CACHED_BY_SERVER
Definition: IAgoraRtmService.h:345
agora::rtm::PEER_MESSAGE_ERR_TOO_OFTEN
@ PEER_MESSAGE_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:350
agora::rtm::PEER_MESSAGE_ERR_OK
@ PEER_MESSAGE_ERR_OK
Definition: IAgoraRtmService.h:325
agora::rtm::PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
@ PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:375
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:809
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
@ GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:839
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_OK
@ GET_CHANNEL_MEMBER_COUNT_ERR_OK
Definition: IAgoraRtmService.h:814
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
@ GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT
Definition: IAgoraRtmService.h:834
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
@ GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:829
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
@ GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:849
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
@ GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE
Definition: IAgoraRtmService.h:819
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
@ GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:824
agora::rtm::GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
@ GET_CHANNEL_MEMBER_COUNT_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:844
agora::rtm::LEAVE_CHANNEL_ERR
LEAVE_CHANNEL_ERR
Error codes related to leaving a channel.
Definition: IAgoraRtmService.h:442
agora::rtm::LEAVE_CHANNEL_ERR_OK
@ LEAVE_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:447
agora::rtm::LEAVE_CHANNEL_ERR_NOT_INITIALIZED
@ LEAVE_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:467
agora::rtm::LEAVE_CHANNEL_ERR_REJECTED
@ LEAVE_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:457
agora::rtm::LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
@ LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL
Definition: IAgoraRtmService.h:462
agora::rtm::LEAVE_CHANNEL_ERR_FAILURE
@ LEAVE_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:452
agora::rtm::LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:472
agora::rtm::JOIN_CHANNEL_ERR
JOIN_CHANNEL_ERR
Error codes related to joining a channel.
Definition: IAgoraRtmService.h:381
agora::rtm::JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
@ JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN
Definition: IAgoraRtmService.h:426
agora::rtm::JOIN_CHANNEL_ERR_FAILURE
@ JOIN_CHANNEL_ERR_FAILURE
Definition: IAgoraRtmService.h:391
agora::rtm::JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
@ JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:436
agora::rtm::JOIN_CHANNEL_ERR_OK
@ JOIN_CHANNEL_ERR_OK
Definition: IAgoraRtmService.h:386
agora::rtm::JOIN_CHANNEL_ERR_REJECTED
@ JOIN_CHANNEL_ERR_REJECTED
Definition: IAgoraRtmService.h:396
agora::rtm::JOIN_CHANNEL_ERR_TOO_OFTEN
@ JOIN_CHANNEL_ERR_TOO_OFTEN
Definition: IAgoraRtmService.h:421
agora::rtm::JOIN_CHANNEL_ERR_ALREADY_JOINED
@ JOIN_CHANNEL_ERR_ALREADY_JOINED
Definition: IAgoraRtmService.h:416
agora::rtm::JOIN_CHANNEL_TIMEOUT
@ JOIN_CHANNEL_TIMEOUT
Definition: IAgoraRtmService.h:406
agora::rtm::JOIN_CHANNEL_ERR_EXCEED_LIMIT
@ JOIN_CHANNEL_ERR_EXCEED_LIMIT
Definition: IAgoraRtmService.h:411
agora::rtm::JOIN_CHANNEL_ERR_NOT_INITIALIZED
@ JOIN_CHANNEL_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:431
agora::rtm::JOIN_CHANNEL_ERR_INVALID_ARGUMENT
@ JOIN_CHANNEL_ERR_INVALID_ARGUMENT
Definition: IAgoraRtmService.h:401
agora::rtm::LOG_FILTER_TYPE
LOG_FILTER_TYPE
Output log filter level.
Definition: IAgoraRtmService.h:2222
agora::rtm::LOG_FILTER_ERROR
@ LOG_FILTER_ERROR
Definition: IAgoraRtmService.h:2242
agora::rtm::LOG_FILTER_CRITICAL
@ LOG_FILTER_CRITICAL
Definition: IAgoraRtmService.h:2247
agora::rtm::LOG_FILTER_INFO
@ LOG_FILTER_INFO
Definition: IAgoraRtmService.h:2232
agora::rtm::LOG_FILTER_MASK
@ LOG_FILTER_MASK
Definition: IAgoraRtmService.h:2251
agora::rtm::LOG_FILTER_WARN
@ LOG_FILTER_WARN
Definition: IAgoraRtmService.h:2237
agora::rtm::LOG_FILTER_OFF
@ LOG_FILTER_OFF
Definition: IAgoraRtmService.h:2227
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:959
agora::rtm::CANCEL_MEDIA_ERR_NOT_LOGGED_IN
@ CANCEL_MEDIA_ERR_NOT_LOGGED_IN
Definition: IAgoraRtmService.h:983
agora::rtm::CANCEL_MEDIA_ERR_NOT_INITIALIZED
@ CANCEL_MEDIA_ERR_NOT_INITIALIZED
Definition: IAgoraRtmService.h:978
agora::rtm::CANCEL_MEDIA_ERR_NOT_EXIST
@ CANCEL_MEDIA_ERR_NOT_EXIST
Definition: IAgoraRtmService.h:973
agora::rtm::CANCEL_MEDIA_ERR_OK
@ CANCEL_MEDIA_ERR_OK
Definition: IAgoraRtmService.h:963
agora::rtm::CANCEL_MEDIA_ERR_FAILURE
@ CANCEL_MEDIA_ERR_FAILURE
Definition: IAgoraRtmService.h:968
agora
Definition: IAgoraRtmCallManager.h:11
agora::rtm::ChannelAttributeOptions
Data structure holding channel attribute-specific options.
Definition: IAgoraRtmService.h:1144
agora::rtm::ChannelAttributeOptions::enableNotificationToChannelMembers
bool enableNotificationToChannelMembers
Definition: IAgoraRtmService.h:1154
agora::rtm::ChannelAttributeOptions::ChannelAttributeOptions
ChannelAttributeOptions()
Definition: IAgoraRtmService.h:1155
agora::rtm::ChannelMemberCount
The data structure holding a channel ID and the current channel member count.
Definition: IAgoraRtmService.h:1504
agora::rtm::ChannelMemberCount::count
int count
Definition: IAgoraRtmService.h:1515
agora::rtm::ChannelMemberCount::channelId
const char * channelId
Definition: IAgoraRtmService.h:1508
agora::rtm::MediaOperationProgress
A data structure representing the upload ratio or download ratio.
Definition: IAgoraRtmService.h:1073
agora::rtm::MediaOperationProgress::totalSize
long long totalSize
Definition: IAgoraRtmService.h:1077
agora::rtm::MediaOperationProgress::currentSize
long long currentSize
Definition: IAgoraRtmService.h:1081
agora::rtm::PeerOnlineStatus
The data structure holding an RTM user and the user's online status.
Definition: IAgoraRtmService.h:1473
agora::rtm::PeerOnlineStatus::peerId
const char * peerId
Definition: IAgoraRtmService.h:1478
agora::rtm::PeerOnlineStatus::onlineState
PEER_ONLINE_STATE onlineState
Definition: IAgoraRtmService.h:1497
agora::rtm::PeerOnlineStatus::isOnline
bool isOnline
Definition: IAgoraRtmService.h:1488
agora::rtm::RtmAttribute
A data structure holding a user attribute key and its value.
Definition: IAgoraRtmService.h:1056
agora::rtm::RtmAttribute::value
const char * value
Definition: IAgoraRtmService.h:1066
agora::rtm::RtmAttribute::key
const char * key
Definition: IAgoraRtmService.h:1061
agora::rtm::RtmServiceContext
Definition: IAgoraRtmService.h:3061
agora::rtm::RtmServiceContext::areaCode
int areaCode
Definition: IAgoraRtmService.h:3065
agora::rtm::RtmServiceContext::proxyType
RTM_CLOUD_PROXY_TYPE proxyType
Definition: IAgoraRtmService.h:3070
agora::rtm::SendMessageOptions
Message sending options.
Definition: IAgoraRtmService.h:1022
agora::rtm::SendMessageOptions::enableHistoricalMessaging
bool enableHistoricalMessaging
Definition: IAgoraRtmService.h:1042
agora::rtm::SendMessageOptions::enableOfflineMessaging
bool enableOfflineMessaging
Definition: IAgoraRtmService.h:1033
agora::rtm::SendMessageOptions::SendMessageOptions
SendMessageOptions()
Definition: IAgoraRtmService.h:1044