AgoraRtmPeerSubscriptionStatusErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to subscribing to or unsubscribing from the status of specified peers.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmPeerSubscriptionStatusErrorCode ) {


                   AgoraRtmPeerSubscriptionStatusErrorOk = 0,


                   AgoraRtmPeerSubscriptionStatusErrorFailure = 1,


                   AgoraRtmPeerSubscriptionStatusErrorInvalidArgument =
                2,


                   AgoraRtmPeerSubscriptionStatusErrorRejected = 3,


                   AgoraRtmPeerSubscriptionStatusErrorTimeout = 4,


                   AgoraRtmPeerSubscriptionStatusErrorTooOften = 5,


                   AgoraRtmPeerSubscriptionStatusErrorOverflow = 6,


                   AgoraRtmPeerSubscriptionStatusErrorNotInitialized =
                101,


                   AgoraRtmPeerSubscriptionStatusErrorNotLoggedIn = 102,


                };

Constants

AgoraRtmPeerSubscriptionStatusErrorOk

0: The method call succeeds, or the operation succeeds.

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorFailure

1: Common failure. The user fails to subscribe to or unsubscribe from the status of the specified peers.

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorInvalidArgument

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

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorRejected

3: RESERVED FOR FUTURE USE

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorTimeout

4: The SDK fails to receive a response from the server in 10 seconds. The current timeout is set as 10 seconds. Possible reasons: The user is in the \ref agora::rtm::CONNECTION_STATE_ABORTED “CONNECTION_STATE_ABORTED” or \ref agora::rtm::CONNECTION_STATE_RECONNECTING “CONNECTION_STATE_RECONNECTING” state.

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorTooOften

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

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorOverflow

6: The number of peers, to whom you subscribe, exceeds the limit of 512.

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmPeerSubscriptionStatusErrorNotLoggedIn

102: The user does not call the loginByToken method, or the method call of loginByToken does not succeed before this operation.

Declared In AgoraRtmKit.h.