AgoraRtmEnumerates.h

Go to the documentation of this file.

#import <Foundation/Foundation.h>
 
typedef NS_OPTIONS(NSUInteger, AgoraRtmAreaCode) {
  AgoraRtmAreaCodeCN = 0x00000001,
  AgoraRtmAreaCodeNA = 0x00000002,
  AgoraRtmAreaCodeEU = 0x00000004,
  AgoraRtmAreaCodeAS = 0x00000008,
  AgoraRtmAreaCodeJP = 0x00000010,
  AgoraRtmAreaCodeIN = 0x00000020,
  AgoraRtmAreaCodeGLOB = (0xFFFFFFFF)
};  
 
typedef NS_ENUM(NSInteger, AgoraRtmEncryptionMode) {
  /*
   * Disable message encryption.
   */
  AgoraRtmEncryptionNone = 0,
  /*
   * 128-bit AES encryption, GCM mode.
   */
  AgoraRtmEncryptionAES128GCM = 1,
  /*
   * 256-bit AES encryption, GCM mode.
   */
  AgoraRtmEncryptionAES256GCM  = 2,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmMessagePriority) {
  AgoraRtmMessagePriorityHighest = 0,
  AgoraRtmMessagePriorityHigh = 1,
  AgoraRtmMessagePriorityNormal = 4,
  AgoraRtmMessagePriorityLow = 8,
 
};
 
typedef NS_ENUM(NSInteger, AgoraRtmErrorCode) {
  AgoraRtmErrorOk = 0,
 
  AgoraRtmErrorNotInitialized = -10001,
  AgoraRtmErrorNotLogin = -10002,
  AgoraRtmErrorInvalidAppId = -10003,
  AgoraRtmErrorInvalidEventHandler = -10004,
  AgoraRtmErrorInvalidToken = -10005,
  AgoraRtmErrorInvalidUserId = -10006,
  AgoraRtmErrorInitServiceFailed = -10007,
  AgoraRtmErrorInvalidChannelName = -10008,
  AgoraRtmErrorTokenExpired = -10009,
  AgoraRtmErrorLoginNoServerResources = -10010,
  AgoraRtmErrorLoginTimeout = -10011,
  AgoraRtmErrorLoginRejected = -10012,
  AgoraRtmErrorLoginAborted = -10013,
  AgoraRtmErrorInvalidParameter = -10014,
  AgoraRtmErrorLoginNotAuthorized= -10015,
  AgoraRtmErrorLoginInconsistentAppId = -10016,
  AgoraRtmErrorDuplicateOperation = -10017,
  AgoraRtmErrorInstanceAlreadyReleased = -10018,
  AgoraRtmErrorInvalidChannelType = -10019,
  AgoraRtmErrorInvalidEncryptionParameter = -10020,
  AgoraRtmErrorOperationRateExceedLimitation = -10021,
  AgoraRtmErrorServiceNotSupport = -10022,
  AgoraRtmErrorLoginCanceled = -10023,
  AgoraRtmErrorInvalidPrivateConfig = -10024,
  AgoraRtmErrorNotConnected = -10025,
  AgoraRtmErrorRenewTokenTimeout = -10026,
 
  AgoraRtmErrorChannelNotJoined = -11001,
  AgoraRtmErrorChannelNotSubscribed = -11002,
  AgoraRtmErrorChannelExceedTopicUserLimitation = -11003,
  AgoraRtmErrorChannelReused = -11004,
  AgoraRtmErrorChannelInstanceExceedLimitation = -11005,
  AgoraRtmErrorChannelInErrorState = -11006,
  AgoraRtmErrorChannelJoinFailed = -11007,
  AgoraRtmErrorChannelInvalidTopicName = -11008,
  AgoraRtmErrorChannelInvalidMessage = -11009,
  AgoraRtmErrorChannelMessageLengthExceedLimitation= -11010,
  AgoraRtmErrorChannelInvalidUserList = -11011,
  AgoraRtmErrorChannelNotAvailable = -11012,
  AgoraRtmErrorChannelTopicNotSubscribed = -11013,
  AgoraRtmErrorChannelExceedTopicLimitation = -11014,
  AgoraRtmErrorChannelJoinTopicFailed = -11015,
  AgoraRtmErrorChannelTopicNotJoined = -11016,
  AgoraRtmErrorChannelTopicNotExist = -11017,
  AgoraRtmErrorChannelInvalidTopicMeta = -11018,
  AgoraRtmErrorChannelSubscribeTimeout = -11019,
  AgoraRtmErrorChannelSubscribeTooFrequent = -11020,
  AgoraRtmErrorChannelSubscribeFailed = -11021,
  AgoraRtmErrorChannelUnsubscribeFailed = -11022,
  AgoraRtmErrorChannelEncryptMessageFailed = -11023,
  AgoraRtmErrorChannelPublishMessageFailed = -11024,
  AgoraRtmErrorChannelPublishMessageTooFrequent = -11025,
  AgoraRtmErrorChannelPublishMessageTimeout = -11026, 
  AgoraRtmErrorChannelNotConnected = -11027,
  AgoraRtmErrorChannelLeaveFailed = -11028,
  AgoraRtmErrorChannelCustomTypeLengthOverflow = -11029,
  AgoraRtmErrorChannelInvalidCustomType = -11030,
  AgoraRtmErrorChannelUnsupportedMessageType = -11031,
  AgoraRtmErrorChannelPresenceNotReady = -11032,
   AgoraRtmErrorChannelReceiverOffline = -11033,
  AgoraRtmErrorChannelJoinCanceled = -11034,
  AgoraRtmErrorChannelReceiverOfflineButMessageStoreSucceeded = -11035,
  AgoraRtmErrorChannelReceiverOfflineAndMessageStoreFailed = -11036,
  AgoraRtmErrorChannelMessageDeliveredButStoreFailed = -11037,
 
  AgoraRtmErrorStorageOperationFailed = -12001,
  AgoraRtmErrorStorageMetadataItemExceedLimitation= -12002,
  AgoraRtmErrorStorageInvalidMetadataItem = -12003,
  AgoraRtmErrorStorageInvalidArgument = -12004,
  AgoraRtmErrorStorageInvalidRevision = -12005,
  AgoraRtmErrorStorageMetadataLengthOverflow = -12006,
  AgoraRtmErrorStorageInvalidLockName= -12007,
  AgoraRtmErrorStorageLockNotAcquired = -12008,
  AgoraRtmErrorStorageInvalidKey = -12009,
  AgoraRtmErrorStorageInvalidValue = -12010,
  AgoraRtmErrorStorageKeyLengthOverflow= -12011,
  AgoraRtmErrorStorageValueLengthOverflow= -12012,
  AgoraRtmErrorStorageDuplicateKey = -12013,
  AgoraRtmErrorStorageOutdatedRevision = -12014,
  AgoraRtmErrorStorageNotSubscribe = -12015,
  AgoraRtmErrorStorageInvalidMetadataInstance = -12016,
  AgoraRtmErrorStorageSubscribeUserExceedLimitation = -12017,
  AgoraRtmErrorStorageOperationTimeout = -12018,
  AgoraRtmErrorStorageNotAvailable = -12019,
 
  AgoraRtmErrorPresenceNotConnected = -13001,
  AgoraRtmErrorPresenceNotWritable = -13002,
  AgoraRtmErrorPresenceInvalidArgument = -13003,
  AgoraRtmErrorPresenceCacheTooManyStates = -13004,
  AgoraRtmErrorPresenceStateCountOverflow= -13005,
  AgoraRtmErrorPresenceInvalidStateKey = -13006,
  AgoraRtmErrorPresenceInvalidStateValue = -13007,
  AgoraRtmErrorPresenceStateKeySizeOverflow= -13008,
  AgoraRtmErrorPresenceStateValueSizeOverflow= -13009,
  AgoraRtmErrorPresenceStateDuplicateKey = -13010,
  AgoraRtmErrorPresenceUserNotExist = -13011,
  AgoraRtmErrorPresenceOperationTimeout = -13012,
  AgoraRtmErrorPresenceOperationFailed = -13013,
 
  AgoraRtmErrorLockOperationFailed = -14001,
  AgoraRtmErrorLockOperationTimeout = -14002,
  AgoraRtmErrorLockOperationPerforming = -14003,
  AgoraRtmErrorLockAlreadyExist = -14004,
  AgoraRtmErrorLockInvalidName = -14005,
  AgoraRtmErrorLockNotAcquired = -14006,
  AgoraRtmErrorLockAcquireFailed = -14007,
  AgoraRtmErrorLockNotExist = -14008,
  AgoraRtmErrorLockNotAvailable = -14009,
  AgoraRtmErrorHistoryOperationFailed = -15001,
  AgoraRtmErrorHistoryInvalidTimestamp = -15002,
  AgoraRtmErrorHistoryOperationTimeout = -15003,
  AgoraRtmErrorHistoryOperationNotPermitted = -15004,
  AgoraRtmErrorHistoryNotAvailable = -15005,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmStorageType)  {
  AgoraRtmStorageTypeNone = 0,
  AgoraRtmStorageTypeUser = 1,
  AgoraRtmStorageTypeChannel = 2,   
};
 
typedef NS_ENUM(NSInteger, AgoraRtmLockEventType) {
  AgoraRtmLockEventTypeNone = 0,
  AgoraRtmLockEventTypeSnapshot = 1,
  AgoraRtmLockEventTypeLockSet = 2,
  AgoraRtmLockEventTypeLockRemoved = 3,
  AgoraRtmLockEventTypeLockAcquired = 4,
  AgoraRtmLockEventTypeLockReleased = 5,
  AgoraRtmLockEventTypeLockExpired = 6,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmProxyType) {
  AgoraRtmProxyTypeNone = 0,
  AgoraRtmProxyTypeHttp = 1,
  AgoraRtmProxyTypeCloudTcp = 2,
};
 
typedef NS_OPTIONS(NSInteger, AgoraRtmServiceType) {
  AgoraRtmServiceTypeNone = 0x00000000,
  AgoraRtmServiceTypeMessage = 0x00000001,
  AgoraRtmServiceTypeStream = 0x00000002,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmProtocolType) {
  AgoraRtmProtocolTypeTcpUdp = 0,
  AgoraRtmProtocolTypeTcpOnly = 1,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmLinkState) {
  AgoraRtmLinkStateIdle = 0,
  AgoraRtmLinkStateConnecting = 1,
  AgoraRtmLinkStateConnected = 2,
  AgoraRtmLinkStateDisconnected = 3,
  AgoraRtmLinkStateSuspended = 4,
  AgoraRtmLinkStateFailed = 5,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmLinkStateChangeReason) {
  AgoraRtmLinkStateChangeReasonUnknown = 0,
  AgoraRtmLinkStateChangeReasonLogin = 1,
  AgoraRtmLinkStateChangeReasonLoginSuccess = 2,
  AgoraRtmLinkStateChangeReasonLoginTimeout = 3,
  AgoraRtmLinkStateChangeReasonLoginNotAuthorized = 4,
  AgoraRtmLinkStateChangeReasonLoginRejected = 5,
  AgoraRtmLinkStateChangeReasonRelogin = 6,
  AgoraRtmLinkStateChangeReasonLogout = 7,
  AgoraRtmLinkStateChangeReasonAutoReconnect = 8,
  AgoraRtmLinkStateChangeReasonReconnectTimeout = 9,
  AgoraRtmLinkStateChangeReasonReconnectSuccess = 10,
  AgoraRtmLinkStateChangeReasonJoin = 11,
  AgoraRtmLinkStateChangeReasonJoinSuccess = 12,
  AgoraRtmLinkStateChangeReasonJoinFailed = 13,
  AgoraRtmLinkStateChangeReasonRejoin = 14,
  AgoraRtmLinkStateChangeReasonLeave = 15,
  AgoraRtmLinkStateChangeReasonInvalidToken = 16,
  AgoraRtmLinkStateChangeReasonTokenExpired = 17,
  AgoraRtmLinkStateChangeReasonInconsistentAppId = 18,
  AgoraRtmLinkStateChangeReasonInvalidChannelName = 19,
  AgoraRtmLinkStateChangeReasonInvalidUserId = 20,
  AgoraRtmLinkStateChangeReasonNotInitialized = 21,
  AgoraRtmLinkStateChangeReasonRtmServiceNotConnected = 22,
  AgoraRtmLinkStateChangeReasonChannelInstanceExceedLimitation = 23,
  AgoraRtmLinkStateChangeReasonOperationRateExceedLimitation = 24,
  AgoraRtmLinkStateChangeReasonChannelInErrorState = 25,
  AgoraRtmLinkStateChangeReasonPresenceNotConnected = 26,
  AgoraRtmLinkStateChangeReasonSameUidLogin = 27,
  AgoraRtmLinkStateChangeReasonKickedOutByServer = 28,
  AgoraRtmLinkStateChangeReasonKeepAliveTimeout = 29,
  AgoraRtmLinkStateChangeReasonConnectionError = 30,
  AgoraRtmLinkStateChangeReasonPresenceNotReady = 31,
  AgoraRtmLinkStateChangeReasonNetworkChange = 32,
  AgoraRtmLinkStateChangeReasonServiceNotSupported = 33,
  AgoraRtmLinkStateChangeReasonStreamChannelNotAvailable = 34,
  AgoraRtmLinkStateChangeReasonStorageNotAvailable = 35,
  AgoraRtmLinkStateChangeReasonLockNotAvailable = 36,
  AgoraRtmLinkStateChangeReasonLoginTooFrequent = 37,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmLinkOperation) {
  AgoraRtmLinkOperationLogin = 0,
  AgoraRtmLinkOperationLogout = 1,
  AgoraRtmLinkOperationJoin = 2,
  AgoraRtmLinkOperationLeave = 3,
  AgoraRtmLinkOperationServerReject = 4,
  AgoraRtmLinkOperationAutoReconnect = 5,
  AgoraRtmLinkOperationReconnected = 6,
  AgoraRtmLinkOperationHeartbeatTimeout = 7,
  AgoraRtmLinkOperationServerTimeout = 8,
  AgoraRtmLinkOperationNetworkChange = 9,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmTopicEventType) {
  AgoraRtmTopicEventTypeNone = 0,
  AgoraRtmTopicEventTypeSnapshot = 1,
  AgoraRtmTopicEventTypeRemoteJoinTopic = 2,
  AgoraRtmTopicEventTypeRemoteLeaveTopic = 3,
};
 
 typedef NS_ENUM(NSInteger, AgoraRtmPresenceEventType) {
  AgoraRtmPresenceEventTypeNone = 0,
 
  AgoraRtmPresenceEventTypeSnapshot = 1,
  AgoraRtmPresenceEventTypeInterval = 2,
  AgoraRtmPresenceEventTypeRemoteJoinChannel = 3,
  AgoraRtmPresenceEventTypeRemoteLeaveChannel = 4,
  AgoraRtmPresenceEventTypeRemoteConnectionTimeout = 5,
  AgoraRtmPresenceEventTypeRemoteStateChanged = 6,
  AgoraRtmPresenceEventTypeErrorOutOfService = 7,
  
};
 
typedef NS_OPTIONS(NSUInteger, AgoraRtmJoinChannelFeature) {
  AgoraRtmJoinChannelFeatureNone = 0,
  AgoraRtmJoinChannelFeaturePresence = 1,
  AgoraRtmJoinChannelFeatureMetadata = 1 << 1,
  AgoraRtmJoinChannelFeatureLock = 1 << 2,
  AgoraRtmJoinChannelFeatureBeQuiet = 1 << 3,
};
 
typedef NS_OPTIONS(NSUInteger, AgoraRtmSubscribeChannelFeature) {
  AgoraRtmSubscribeChannelFeatureNone = 0,
  AgoraRtmSubscribeChannelFeaturePresence = 1,
  AgoraRtmSubscribeChannelFeatureMetadata = 1 << 1,
  AgoraRtmSubscribeChannelFeatureMessage = 1 << 2,
  AgoraRtmSubscribeChannelFeatureLock =  1 << 3,
  AgoraRtmSubscribeChannelFeatureBeQuiet = 1 << 4,
};
 
 
typedef NS_ENUM(NSInteger, AgoraRtmClientConnectionState) {
  AgoraRtmClientConnectionStateDisconnected = 1,
  AgoraRtmClientConnectionStateConnecting = 2,
  AgoraRtmClientConnectionStateConnected = 3,
  AgoraRtmClientConnectionStateReconnecting = 4,
  AgoraRtmClientConnectionStateFailed = 5,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmClientConnectionChangeReason) {
  AgoraRtmClientConnectionChangedConnecting = 0,
  AgoraRtmClientConnectionChangedJoinSuccess = 1,
  AgoraRtmClientConnectionChangedInterrupted = 2,
  AgoraRtmClientConnectionChangedBannedByServer = 3,
  AgoraRtmClientConnectionChangedJoinFailed = 4,
  AgoraRtmClientConnectionChangedLeaveChannel = 5,
  AgoraRtmClientConnectionChangedInvalidAppId = 6,
  AgoraRtmClientConnectionChangedInvalidChannelName = 7,
  AgoraRtmClientConnectionChangedInvalidToken = 8,
  AgoraRtmClientConnectionChangedTokenExpired = 9,
  AgoraRtmClientConnectionChangedRejectedByServer = 10,
  AgoraRtmClientConnectionChangedSettingProxyServer = 11,
  AgoraRtmClientConnectionChangedRenewToken = 12,
  AgoraRtmClientConnectionChangedClientIpAddressChanged = 13,
  AgoraRtmClientConnectionChangedKeepAliveTimeout = 14,
  AgoraRtmClientConnectionChangedRejoinSuccess = 15,
  AgoraRtmClientConnectionChangedChangedLost = 16,
  AgoraRtmClientConnectionChangedEchoTest = 17,
  AgoraRtmClientConnectionChangedClientIpAddressChangedByUser = 18,
  AgoraRtmClientConnectionChangedSameUidLogin = 19,
  AgoraRtmClientConnectionChangedTooManyBroadcasters = 20,
  AgoraRtmClientConnectionChangedLicenseValidationFailure = 21,
  AgoraRtmClientConnectionChangedCertificationVerifyFailure = 22,
  AgoraRtmClientConnectionChangedStreamChannelNotAvailable = 23,
  AgoraRtmClientConnectionChangedInconsistentAppId = 24,
  AgoraRtmClientConnectionChangedLoginSuccess = 10001,
  AgoraRtmClientConnectionChangedLogout = 10002,
  AgoraRtmClientConnectionChangedPresenceNotReady = 10003,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmChannelType) {
  AgoraRtmChannelTypeNone = 0,
  AgoraRtmChannelTypeMessage = 1,
  AgoraRtmChannelTypeStream = 2,
  AgoraRtmChannelTypeUser = 3,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmStorageEventType) {
  AgoraRtmStorageEventTypeNone= 0,
  AgoraRtmStorageEventTypeSnapshot = 1,
  AgoraRtmStorageEventTypeSet = 2,
  AgoraRtmStorageEventTypeUpdate = 3,
  AgoraRtmStorageEventTypeRemove = 4,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmPresenceType) {
  AgoraRtmPresenceTypeRemoteJoinChannel = 0,
  AgoraRtmPresenceTypeRemoteLeaveChannel = 1,
  AgoraRtmPresenceTypeRemoteConnectionTimeout = 2,
  AgoraRtmPresenceTypeRemoteJoinTopic = 3,
  AgoraRtmPresenceTypeRemoteLeaveTopic = 4,
  AgoraRtmPresenceTypeSelfJoinChannel = 5,
};
 
typedef NS_ENUM(NSInteger, AgoraRtmMessageQos) {
    AgoraRtmMessageQosUnordered = 0,
    AgoraRtmMessageQosOrdered = 1,
};
 
typedef NS_ENUM (NSInteger, AgoraRtmLogLevel) {
  AgoraRtmLogLevelNone = 0x0000,
  AgoraRtmLogLevelInfo = 0x0001,
  AgoraRtmLogLevelWarn = 0x0002,
  AgoraRtmLogLevelError = 0x0004,
  AgoraRtmLogLevelFatal = 0x0008,
};