AgoraRtmQueryPeersOnlineErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to querying the online status of the specified peers.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmQueryPeersOnlineErrorCode ) {


                   AgoraRtmQueryPeersOnlineErrorOk = 0,


                   AgoraRtmQueryPeersOnlineErrorFailure = 1,


                   AgoraRtmQueryPeersOnlineErrorInvalidArgument = 2,


                   AgoraRtmQueryPeersOnlineErrorRejected = 3,


                   AgoraRtmQueryPeersOnlineErrorTimeout = 4,


                   AgoraRtmQueryPeersOnlineErrorTooOften = 5,


                   AgoraRtmQueryPeersOnlineErrorNotInitialized = 101,


                   AgoraRtmQueryPeersOnlineErrorNotLoggedIn = 102,


                };

Constants

AgoraRtmQueryPeersOnlineErrorOk

0: The method call succeeds.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorFailure

1: The method call fails.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorInvalidArgument

2: The method call fails. The argument is invalid.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorRejected

3: RESERVED FOR FUTURE USE

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorTimeout

4: The SDK has not received a response from the server for 10 seconds. The current timeout is set as 10 seconds. Possible reasons: The user is in the AgoraRtmConnectionStateAborted or AgoraRtmConnectionStateReconnecting state.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorTooOften

5: The method call frequency of this method exceeds the limit of 10 queries every five seconds.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersOnlineErrorNotLoggedIn

102: The user does not call the loginByToken method, or the method call of loginByToken does not succeed before querying the online status.

Declared In AgoraRtmKit.h.