|
Signaling (previously RTM) v1.4.8 API Reference for Unity
|
Public Member Functions | |
| delegate void | OnLoginSuccessHandler (int id) |
| delegate void | OnLoginFailureHandler (int id, LOGIN_ERR_CODE errorCode) |
| delegate void | OnRenewTokenResultHandler (int id, string token, RENEW_TOKEN_ERR_CODE errorCode) |
| delegate void | OnTokenExpiredHandler (int id) |
| delegate void | OnLogoutHandler (int id, LOGOUT_ERR_CODE errorCode) |
| delegate void | OnConnectionStateChangedHandler (int id, CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason) |
| delegate void | OnSendMessageResultHandler (int id, Int64 messageId, PEER_MESSAGE_ERR_CODE errorCode) |
| delegate void | OnMessageReceivedFromPeerHandler (int id, string peerId, TextMessage message) |
| delegate void | OnImageMessageReceivedFromPeerHandler (int id, string peerId, ImageMessage message) |
| delegate void | OnFileMessageReceivedFromPeerHandler (int id, string peerId, FileMessage message) |
| delegate void | OnMediaUploadingProgressHandler (int id, Int64 requestId, MediaOperationProgress progress) |
| delegate void | OnMediaDownloadingProgressHandler (int id, Int64 requestId, MediaOperationProgress progress) |
| delegate void | OnFileMediaUploadResultHandler (int id, Int64 requestId, FileMessage fileMessage, UPLOAD_MEDIA_ERR_CODE code) |
| delegate void | OnImageMediaUploadResultHandler (int id, Int64 requestId, ImageMessage imageMessage, UPLOAD_MEDIA_ERR_CODE code) |
| delegate void | OnMediaDownloadToFileResultHandler (int id, Int64 requestId, DOWNLOAD_MEDIA_ERR_CODE code) |
| delegate void | OnMediaDownloadToMemoryResultHandler (int id, Int64 requestId, byte[] memory, Int64 length, DOWNLOAD_MEDIA_ERR_CODE code) |
| delegate void | OnMediaCancelResultHandler (int id, Int64 requestId, CANCEL_MEDIA_ERR_CODE code) |
| delegate void | OnQueryPeersOnlineStatusResultHandler (int id, Int64 requestId, PeerOnlineStatus[] peersStatus, int peerCount, QUERY_PEERS_ONLINE_STATUS_ERR errorCode) |
| delegate void | OnSubscriptionRequestResultHandler (int id, Int64 requestId, PEER_SUBSCRIPTION_STATUS_ERR errorCode) |
| delegate void | OnQueryPeersBySubscriptionOptionResultHandler (int id, Int64 requestId, string[] peerIds, int peerCount, QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR errorCode) |
| delegate void | OnSetLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnAddOrUpdateLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnDeleteLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnClearLocalUserAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnGetUserAttributesResultHandler (int id, Int64 requestId, string userId, RtmAttribute[] attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnSetChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnAddOrUpdateChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnDeleteChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnClearChannelAttributesResultHandler (int id, Int64 requestId, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnGetChannelAttributesResultHandler (int id, Int64 requestId, RtmChannelAttribute[] attributes, int numberOfAttributes, ATTRIBUTE_OPERATION_ERR errorCode) |
| delegate void | OnGetChannelMemberCountResultHandler (int id, Int64 requestId, ChannelMemberCount[] channelMemberCounts, int channelCount, GET_CHANNEL_MEMBER_COUNT_ERR_CODE errorCode) |
| delegate void | OnPeersOnlineStatusChangedHandler (int id, PeerOnlineStatus[] peersStatus, int peerCount) |
| RtmClientEventHandler () | |
| void | Release () |
| IntPtr | GetPtr () |
|
inline |
|
inline |
| delegate void agora_rtm.RtmClientEventHandler.OnAddOrUpdateChannelAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. |
| delegate void agora_rtm.RtmClientEventHandler.OnAddOrUpdateLocalUserAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnClearChannelAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the ClearChannelAttributes method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnClearLocalUserAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the ClearLocalUserAttributes method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnConnectionStateChangedHandler | ( | int | id, |
| CONNECTION_STATE | state, | ||
| CONNECTION_CHANGE_REASON | reason | ||
| ) |
Occurs when the connection state changes between the SDK and the Agora RTM system.
| id | The id of your engine |
| state | The new connection state. See CONNECTION_STATE. |
| reason | The reason for the connection state change. See CONNECTION_CHANGE_REASON. |
| delegate void agora_rtm.RtmClientEventHandler.OnDeleteChannelAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the DeleteChannelAttributesByKeys method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnDeleteLocalUserAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the DeleteLocalUserAttributesByKeys method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnFileMediaUploadResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| FileMessage | fileMessage, | ||
| UPLOAD_MEDIA_ERR_CODE | code | ||
| ) |
Reports the result of the CreateFileMessageByUploading method call.
| id | The id of your engine |
| requestId | The unique ID of the upload request. |
| fileMessage | An FileMessage instance. |
| code | Error Codes. See UPLOAD_MEDIA_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnFileMessageReceivedFromPeerHandler | ( | int | id, |
| string | peerId, | ||
| FileMessage | message | ||
| ) |
Occurs when receiving a peer-to-peer file message.
| id | The id of your engine |
| peerId | The ID of the message sender. |
| message | The received peer-to-peer file message. See FileMessage. |
| delegate void agora_rtm.RtmClientEventHandler.OnGetChannelAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| RtmChannelAttribute[] | attributes, | ||
| int | numberOfAttributes, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the GetChannelAttributes or "GetChannelAttributesByKeys" method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnGetChannelMemberCountResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ChannelMemberCount[] | channelMemberCounts, | ||
| int | channelCount, | ||
| GET_CHANNEL_MEMBER_COUNT_ERR_CODE | errorCode | ||
| ) |
Reports the result of the GetChannelMemberCount method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnGetUserAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| string | userId, | ||
| RtmAttribute[] | attributes, | ||
| int | numberOfAttributes, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the GetUserAttributes or GetUserAttributesByKeys method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnImageMediaUploadResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ImageMessage | imageMessage, | ||
| UPLOAD_MEDIA_ERR_CODE | code | ||
| ) |
Reports the result of the CreateImageMessageByUploading method call.
| id | The id of your engine |
| requestId | The unique ID of the upload request. |
| imageMessage | An ImageMessage instance. |
| code | Error Codes. See UPLOAD_MEDIA_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnImageMessageReceivedFromPeerHandler | ( | int | id, |
| string | peerId, | ||
| ImageMessage | message | ||
| ) |
Occurs when receiving a peer-to-peer image message.
| id | The id of your engine |
| peerId | The ID of the message sender. |
| message | The received peer-to-peer image message. See ImageMessage. |
| delegate void agora_rtm.RtmClientEventHandler.OnLoginFailureHandler | ( | int | id, |
| LOGIN_ERR_CODE | errorCode | ||
| ) |
Occurs when a user fails to log in the Agora RTM system. The local user receives this callback when the Login method call fails.
| id | The id of your engine |
| errorCode | Error codes related to login. See LOGIN_ERR_CODE for the error codes. |
| delegate void agora_rtm.RtmClientEventHandler.OnLoginSuccessHandler | ( | int | id | ) |
Occurs when a user logs in the Agora RTM system. The local user receives this callback when the Login method call succeeds.
| id | The id of your engine |
| delegate void agora_rtm.RtmClientEventHandler.OnLogoutHandler | ( | int | id, |
| LOGOUT_ERR_CODE | errorCode | ||
| ) |
Occurs when a user logs out of the Agora RTM system.
| id | The id of your engine |
| errorCode | The error code. See LOGOUT_ERR_CODE for the error codes. |
| delegate void agora_rtm.RtmClientEventHandler.OnMediaCancelResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| CANCEL_MEDIA_ERR_CODE | code | ||
| ) |
Reports the result of the CancelMediaDownload or CancelMediaUpload method call.
| id | The id of your engine |
| requestId | The unique ID of the cancel request. |
| code | Error Codes. See CANCEL_MEDIA_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnMediaDownloadingProgressHandler | ( | int | id, |
| Int64 | requestId, | ||
| MediaOperationProgress | progress | ||
| ) |
Reports the progress of an ongoing download task.
| id | The id of your engine |
| requestId | The unique ID of the download request. |
| progress | The progress of the ongoing download task. See MediaOperationProgress. |
| delegate void agora_rtm.RtmClientEventHandler.OnMediaDownloadToFileResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| DOWNLOAD_MEDIA_ERR_CODE | code | ||
| ) |
Reports the result of the DownloadMediaToFile method call.
| id | The id of your engine |
| requestId | The unique ID of the download request. |
| code | Error Codes. See DOWNLOAD_MEDIA_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnMediaDownloadToMemoryResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| byte[] | memory, | ||
| Int64 | length, | ||
| DOWNLOAD_MEDIA_ERR_CODE | code | ||
| ) |
Reports the result of the DownloadMediaToMemory method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnMediaUploadingProgressHandler | ( | int | id, |
| Int64 | requestId, | ||
| MediaOperationProgress | progress | ||
| ) |
Reports the progress of an ongoing upload task.
| id | The id of your engine |
| requestId | The unique ID of the upload request. |
| progress | The progress of the ongoing upload task. See MediaOperationProgress. |
| delegate void agora_rtm.RtmClientEventHandler.OnMessageReceivedFromPeerHandler | ( | int | id, |
| string | peerId, | ||
| TextMessage | message | ||
| ) |
Occurs when receiving a peer-to-peer message.
| id | The id of your engine |
| peerId | The ID of the message sender. |
| message | The received peer-to-peer message. See IMessage. |
| delegate void agora_rtm.RtmClientEventHandler.OnPeersOnlineStatusChangedHandler | ( | int | id, |
| PeerOnlineStatus[] | peersStatus, | ||
| int | peerCount | ||
| ) |
Occurs when the online status of the peers, to whom you subscribe, changes.
| id | The id of your engine |
| peersStatus | An array of peers' online states. See PeerOnlineStatus. |
| peerCount | Count of the peers, whose online status changes. |
| delegate void agora_rtm.RtmClientEventHandler.OnQueryPeersBySubscriptionOptionResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| string[] | peerIds, | ||
| int | peerCount, | ||
| QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR | errorCode | ||
| ) |
Returns the result of the QueryPeersBySubscriptionOption method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnQueryPeersOnlineStatusResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| PeerOnlineStatus[] | peersStatus, | ||
| int | peerCount, | ||
| QUERY_PEERS_ONLINE_STATUS_ERR | errorCode | ||
| ) |
Reports the result of the QueryPeersOnlineStatus method call.
| id | The id of your engine |
| 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. |
| delegate void agora_rtm.RtmClientEventHandler.OnRenewTokenResultHandler | ( | int | id, |
| string | token, | ||
| RENEW_TOKEN_ERR_CODE | errorCode | ||
| ) |
Reports the result of the RenewToken method call.
| id | The id of your engine |
| token | Your new token. |
| errorCode | The error code. See RENEW_TOKEN_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnSendMessageResultHandler | ( | int | id, |
| Int64 | messageId, | ||
| PEER_MESSAGE_ERR_CODE | errorCode | ||
| ) |
Reports the result of the SendMessageToPeer method call.
| id | The id of your engine |
| messageId | The ID of the sent message. |
| errorCode | The peer-to-peer message state. See PEER_MESSAGE_ERR_CODE. |
| delegate void agora_rtm.RtmClientEventHandler.OnSetChannelAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
Reports the result of the SetChannelAttributes method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnSetLocalUserAttributesResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| ATTRIBUTE_OPERATION_ERR | errorCode | ||
| ) |
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See ATTRIBUTE_OPERATION_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnSubscriptionRequestResultHandler | ( | int | id, |
| Int64 | requestId, | ||
| PEER_SUBSCRIPTION_STATUS_ERR | errorCode | ||
| ) |
Returns the result of the SubscribePeersOnlineStatus or UnsubscribePeersOnlineStatus method call.
| id | The id of your engine |
| requestId | The unique ID of this request. |
| errorCode | Error Codes. See PEER_SUBSCRIPTION_STATUS_ERR. |
| delegate void agora_rtm.RtmClientEventHandler.OnTokenExpiredHandler | ( | int | id | ) |
Occurs when the RTM server detects that the RTM token has exceeded the 24-hour validity period and when the SDK is in the CONNECTION_STATE_RECONNECTING state. This callback occurs only when the SDK is reconnecting to the server. You will not receive this callback when the SDK is in the CONNECTION_STATE_CONNECTED state. When receiving this callback, generate a new RTM Token on the server and call the RenewToken method to pass the new Token on to the server.
| id | The id of your engine |
|
inline |
| OnAddOrUpdateChannelAttributesResultHandler agora_rtm.RtmClientEventHandler.OnAddOrUpdateChannelAttributesResult |
| OnAddOrUpdateLocalUserAttributesResultHandler agora_rtm.RtmClientEventHandler.OnAddOrUpdateLocalUserAttributesResult |
| OnClearChannelAttributesResultHandler agora_rtm.RtmClientEventHandler.OnClearChannelAttributesResult |
| OnClearLocalUserAttributesResultHandler agora_rtm.RtmClientEventHandler.OnClearLocalUserAttributesResult |
| OnConnectionStateChangedHandler agora_rtm.RtmClientEventHandler.OnConnectionStateChanged |
| OnDeleteChannelAttributesResultHandler agora_rtm.RtmClientEventHandler.OnDeleteChannelAttributesResult |
| OnDeleteLocalUserAttributesResultHandler agora_rtm.RtmClientEventHandler.OnDeleteLocalUserAttributesResult |
| OnFileMediaUploadResultHandler agora_rtm.RtmClientEventHandler.OnFileMediaUploadResult |
| OnFileMessageReceivedFromPeerHandler agora_rtm.RtmClientEventHandler.OnFileMessageReceivedFromPeer |
| OnGetChannelAttributesResultHandler agora_rtm.RtmClientEventHandler.OnGetChannelAttributesResult |
| OnGetChannelMemberCountResultHandler agora_rtm.RtmClientEventHandler.OnGetChannelMemberCountResult |
| OnGetUserAttributesResultHandler agora_rtm.RtmClientEventHandler.OnGetUserAttributesResult |
| OnImageMediaUploadResultHandler agora_rtm.RtmClientEventHandler.OnImageMediaUploadResult |
| OnImageMessageReceivedFromPeerHandler agora_rtm.RtmClientEventHandler.OnImageMessageReceivedFromPeer |
| OnLoginFailureHandler agora_rtm.RtmClientEventHandler.OnLoginFailure |
| OnLoginSuccessHandler agora_rtm.RtmClientEventHandler.OnLoginSuccess |
| OnLogoutHandler agora_rtm.RtmClientEventHandler.OnLogout |
| OnMediaCancelResultHandler agora_rtm.RtmClientEventHandler.OnMediaCancelResult |
| OnMediaDownloadingProgressHandler agora_rtm.RtmClientEventHandler.OnMediaDownloadingProgress |
| OnMediaDownloadToFileResultHandler agora_rtm.RtmClientEventHandler.OnMediaDownloadToFileResult |
| OnMediaDownloadToMemoryResultHandler agora_rtm.RtmClientEventHandler.OnMediaDownloadToMemoryResult |
| OnMediaUploadingProgressHandler agora_rtm.RtmClientEventHandler.OnMediaUploadingProgress |
| OnMessageReceivedFromPeerHandler agora_rtm.RtmClientEventHandler.OnMessageReceivedFromPeer |
| OnPeersOnlineStatusChangedHandler agora_rtm.RtmClientEventHandler.OnPeersOnlineStatusChanged |
| OnQueryPeersBySubscriptionOptionResultHandler agora_rtm.RtmClientEventHandler.OnQueryPeersBySubscriptionOptionResult |
| OnQueryPeersOnlineStatusResultHandler agora_rtm.RtmClientEventHandler.OnQueryPeersOnlineStatusResult |
| OnRenewTokenResultHandler agora_rtm.RtmClientEventHandler.OnRenewTokenResult |
| OnSendMessageResultHandler agora_rtm.RtmClientEventHandler.OnSendMessageResult |
| OnSetChannelAttributesResultHandler agora_rtm.RtmClientEventHandler.OnSetChannelAttributesResult |
| OnSetLocalUserAttributesResultHandler agora_rtm.RtmClientEventHandler.OnSetLocalUserAttributesResult |
| OnSubscriptionRequestResultHandler agora_rtm.RtmClientEventHandler.OnSubscriptionRequestResult |
| OnTokenExpiredHandler agora_rtm.RtmClientEventHandler.OnTokenExpired |