AgoraRtmQueryPeersBySubscriptionOptionErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to getting a list of the peers by subscription option type.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmQueryPeersBySubscriptionOptionErrorCode ) {


                   AgoraRtmQueryPeersBySubscriptionOptionErrorOk = 0,


                   AgoraRtmQueryPeersBySubscriptionOptionErrorFailure =
                1,


                   AgoraRtmQueryPeersBySubscriptionOptionErrorTimeout =
                2,


                   AgoraRtmQueryPeersBySubscriptionOptionErrorTooOften =
                3,


                  
                AgoraRtmQueryPeersBySubscriptionOptionErrorNotInitialized = 101,


                   AgoraRtmQueryPeersBySubscriptionOptionErrorNotLoggedIn =
                102,


                };

Constants

AgoraRtmQueryPeersBySubscriptionOptionErrorOk

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

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersBySubscriptionOptionErrorFailure

1: Common failure. The user fails to query peers by subscription option type.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersBySubscriptionOptionErrorTimeout

2: The SDK fails to receive a response from the server in 5 seconds. The current timeout is set as 5 seconds. Possible reasons: The user is in the AgoraRtmConnectionStateAborted or AgoraRtmConnectionStateReconnecting state.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersBySubscriptionOptionErrorTooOften

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

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersBySubscriptionOptionErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmQueryPeersBySubscriptionOptionErrorNotLoggedIn

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.