AgoraRtmGetMembersErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to retrieving a channel member list.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmGetMembersErrorCode ) {


                   AgoraRtmGetMembersErrorOk = 0,


                   AgoraRtmGetMembersErrorFailure = 1,


                   AgoraRtmGetMembersErrorRejected = 2,


                   AgoraRtmGetMembersErrorTimeout = 3,


                   AgoraRtmGetMembersErrorTooOften = 4,


                   AgoraRtmGetMembersErrorNotInChannel = 5,


                   AgoraRtmGetMembersErrorNotInitialized = 101,


                   AgoraRtmGetMembersErrorNotLoggedIn = 102,


                };

Constants

AgoraRtmGetMembersErrorOk

0: The user retrieves a member list of the channel successfully.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorFailure

1: The user fails to retrieve a member list of the channel.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorRejected

2: RESERVED FOR FUTURE USE

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorTimeout

3: A timeout occurs when retreiving a member list of the channel. The current timeout is set as five seconds. Possible reasons: The user is in the AgoraRtmConnectionStateAborted or AgoraRtmConnectionStateReconnecting state.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorTooOften

4: The method call frequency exceeds the limit of five queries every two seconds.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorNotInChannel

5: The user is not in channel.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmGetMembersErrorNotLoggedIn

102: The user does not call the loginByToken method, or the method call of loginByToken does not succeed before retrieving a member list.

Declared In AgoraRtmKit.h.