Signaling (previously RTM) SDK v1.5.0 API Reference for Linux (C++)
|
#include <IAgoraRtmService.h>
Public Member Functions |
|
virtual | ~IRtmServiceEventHandler () |
virtual void | onLoginSuccess () |
virtual void | onLoginFailure (LOGIN_ERR_CODE errorCode) |
virtual void | onRenewTokenResult (const char *token, RENEW_TOKEN_ERR_CODE errorCode) |
virtual void | onTokenExpired () |
virtual void | onTokenPrivilegeWillExpire () |
virtual void | onLogout (LOGOUT_ERR_CODE errorCode) |
virtual void | onConnectionStateChanged (CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason) |
virtual void | onSendMessageResult (long long messageId, PEER_MESSAGE_ERR_CODE errorCode) |
virtual void | onMessageReceivedFromPeer (const char *peerId, const IMessage *message) |
virtual void | onImageMessageReceivedFromPeer (const char *peerId, const IImageMessage *message) |
virtual void | onFileMessageReceivedFromPeer (const char *peerId, const IFileMessage *message) |
virtual void | onMediaUploadingProgress (long long requestId, const MediaOperationProgress &progress) |
virtual void | onMediaDownloadingProgress (long long requestId, const MediaOperationProgress &progress) |
virtual void | onFileMediaUploadResult (long long requestId, IFileMessage *fileMessage, UPLOAD_MEDIA_ERR_CODE code) |
virtual void | onImageMediaUploadResult (long long requestId, IImageMessage *imageMessage, UPLOAD_MEDIA_ERR_CODE code) |
virtual void | onMediaDownloadToFileResult (long long requestId, DOWNLOAD_MEDIA_ERR_CODE code) |
virtual void | onMediaDownloadToMemoryResult (long long requestId, const char *memory, long long length, DOWNLOAD_MEDIA_ERR_CODE code) |
virtual void | onMediaCancelResult (long long requestId, CANCEL_MEDIA_ERR_CODE code) |
virtual void | onQueryPeersOnlineStatusResult (long long requestId, const PeerOnlineStatus *peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode) |
virtual void | onSubscriptionRequestResult (long long requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode) |
virtual void | onQueryPeersBySubscriptionOptionResult (long long requestId, const char *peerIds[], int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode) |
virtual void | onPeersOnlineStatusChanged (const PeerOnlineStatus peersStatus[], int peerCount) |
virtual void | onSetLocalUserAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onAddOrUpdateLocalUserAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onDeleteLocalUserAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onClearLocalUserAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onGetUserAttributesResult (long long requestId, const char *userId, const RtmAttribute *attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onSetChannelAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onAddOrUpdateChannelAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onDeleteChannelAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onClearChannelAttributesResult (long long requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onGetChannelAttributesResult (long long requestId, const IRtmChannelAttribute *attributes[], int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode) |
virtual void | onGetChannelMemberCountResult (long long requestId, const ChannelMemberCount *channelMemberCounts, int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode) |
|
inlinevirtual |
|
inlinevirtual |
Occurs when a user logs in the Agora RTM system.
The local user receives this callback when the login method call succeeds.
|
inlinevirtual |
Occurs when a user fails to log in the Agora RTM system.
The local user receives this callback when the login method call fails. See LOGIN_ERR_CODE for the error codes.
|
inlinevirtual |
Reports the result of the renewToken method call.
token | Your new token. |
errorCode | The error code. See RENEW_TOKEN_ERR_CODE. |
|
inlinevirtual |
Occurs when the RTM server detects that the RTM token has exceeded the specified validity period.
|
inlinevirtual |
Occurs when the token expires in 30 seconds.
|
inlinevirtual |
Occurs when a user logs out of the Agora RTM system.
The local user receives this callback when the SDK calls the logout method. See LOGOUT_ERR_CODE for the error codes.
|
inlinevirtual |
Occurs when the connection state changes between the SDK and the Agora RTM system.
state | The new connection state. See CONNECTION_STATE. |
reason | The reason for the connection state change. See CONNECTION_CHANGE_REASON. |
|
inlinevirtual |
Reports the result of the sendMessageToPeer method call.
messageId | The ID of the sent message. |
errorCode | The peer-to-peer message state. See PEER_MESSAGE_ERR_CODE. |
|
inlinevirtual |
Occurs when receiving a peer-to-peer message.
peerId | The ID of the message sender. |
message | The received peer-to-peer message. See IMessage. |
|
inlinevirtual |
Occurs when receiving a peer-to-peer image message.
peerId | The ID of the message sender. |
message | The received peer-to-peer image message. See IImageMessage. |
|
inlinevirtual |
Occurs when receiving a peer-to-peer file message.
peerId | The ID of the message sender. |
message | The received peer-to-peer file message. See IFileMessage. |
|
inlinevirtual |
Reports the progress of an ongoing upload task.
requestId | The unique ID of the upload request. |
progress | The progress of the ongoing upload task. See MediaOperationProgress. |
|
inlinevirtual |
Reports the progress of an ongoing download task.
requestId | The unique ID of the download request. |
progress | The progress of the ongoing download task. See MediaOperationProgress. |
|
inlinevirtual |
Reports the result of the createFileMessageByUploading method call.
requestId | The unique ID of the upload request. |
fileMessage | An IFileMessage instance. |
code | Error codes. See UPLOAD_MEDIA_ERR_CODE. |
|
inlinevirtual |
Reports the result of the createImageMessageByUploading method call.
requestId | The unique ID of the upload request. |
imageMessage | An IImageMessage instance. |
code | Error codes. See UPLOAD_MEDIA_ERR_CODE. |
|
inlinevirtual |
Reports the result of the downloadMediaToFile method call.
requestId | The unique ID of the download request. |
code | Error codes. See DOWNLOAD_MEDIA_ERR_CODE. |
|
inlinevirtual |
Reports the result of the downloadMediaToMemory method call.
requestId | The unique ID of the download request. |
memory | The memory address where the downloaded file or image is stored. |
length | The size of the downloaded file or image. |
code | Error codes. See DOWNLOAD_MEDIA_ERR_CODE. |
|
inlinevirtual |
Reports the result of the cancelMediaDownload or cancelMediaUpload method call.
requestId | The unique ID of the cancel request. |
code | Error codes. See CANCEL_MEDIA_ERR_CODE. |
|
inlinevirtual |
Reports the result of the queryPeersOnlineStatus method call.
requestId | The unique ID of this request. |
peersStatus | The online status of the peer. See PeerOnlineStatus. |
peerCount | The number of the queried peers. |
errorCode | Error Codes. See QUERY_PEERS_ONLINE_STATUS_ERR. |
|
inlinevirtual |
Returns the result of the subscribePeersOnlineStatus or unsubscribePeersOnlineStatus method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See PEER_SUBSCRIPTION_STATUS_ERR. |
|
inlinevirtual |
Returns the result of the queryPeersBySubscriptionOption method call.
requestId | The unique ID of this request. |
peerIds | A user ID array of the specified users, to whom you subscribe. |
peerCount | Count of the peers. |
errorCode | Error Codes. See QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR. |
|
inlinevirtual |
Occurs when the online status of the peers, to whom you subscribe, changes.
peersStatus | An array of peers' online states. See PeerOnlineStatus. |
peerCount | Count of the peers, whose online status changes. |
|
inlinevirtual |
Reports the result of the setLocalUserAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the addOrUpdateLocalUserAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the deleteLocalUserAttributesByKeys method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the clearLocalUserAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the getUserAttributes or getUserAttributesByKeys method call.
requestId | The unique ID of this request. |
userId | The user ID of the specified user. |
attributes | An array of the returned attributes. See RtmAttribute. |
numberOfAttributes | The total number of the user's attributes |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the setChannelAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the addOrUpdateChannelAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the deleteChannelAttributesByKeys method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the clearChannelAttributes method call.
requestId | The unique ID of this request. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the getChannelAttributes or getChannelAttributesByKeys method call.
requestId | The unique ID of this request. |
attributes | An array of the returned channel attributes. |
numberOfAttributes | The total number of the attributes. |
errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
|
inlinevirtual |
Reports the result of the getChannelMemberCount method call.
requestId | The unique ID of this request. |
channelMemberCounts | An array of the channel member counts. |
channelCount | The total number of the channels. |
errorCode | Error Codes. See GET_CHANNEL_MEMBER_COUNT_ERR_CODE. |