Agora RTC Objective-C API Reference  Refactor
Instance Methods | Properties
AgoraRtmClientConfig Class Reference

Inherits <NSObject>.

Instance Methods

(instancetype _Nonnull) - initWithAppId:userId:
 

Properties

AgoraRtmAreaCode areaCode
 
AgoraRtmProtocolType protocolType
 
unsigned int presenceTimeout
 
unsigned int heartbeatInterval
 
NSString * appId
 
NSString * userId
 
BOOL useStringUserId
 
BOOL multipath
 
AgoraRtmLogConfiglogConfig
 
AgoraRtmProxyConfigproxyConfig
 
AgoraRtmEncryptionConfigencryptionConfig
 
AgoraRtmPrivateConfigprivateConfig
 

Detailed Description

Configurations for RTM Client.

Method Documentation

◆ NS_UNAVAILABLE

- (instancetype _Nullable) NS_UNAVAILABLE

◆ initWithAppId:userId:

- (instancetype _Nonnull) initWithAppId: (NSString *_Nonnull)  appId
userId: (NSString *_Nonnull)  userId 

init with appid adn userid

Property Documentation

◆ areaCode

- (AgoraRtmAreaCode) areaCode
readwritenonatomicassign

The region for connection. This advanced feature applies to scenarios that have regional restrictions.

For the regions that Agora supports, see #AREA_CODE.

After specifying the region, the SDK connects to the Agora servers within that region.

◆ protocolType

- (AgoraRtmProtocolType) protocolType
readwritenonatomicassign

The protocol used for connecting to the Agora RTM service.

◆ presenceTimeout

- (unsigned int) presenceTimeout
readwritenonatomicassign

Presence timeout in seconds, specify the timeout value when you lost connection between sdk and rtm service.

◆ heartbeatInterval

- (unsigned int) heartbeatInterval
readwritenonatomicassign

Heartbeat interval in seconds, specify the interval value of sending heartbeat between sdk and rtm service.

◆ appId

- (NSString*) appId
readwritenonatomiccopy

The App ID of your project.

◆ userId

- (NSString*) userId
readwritenonatomiccopy

The ID of the user.

◆ useStringUserId

- (BOOL) useStringUserId
readwritenonatomicassign

Whether to use String user IDs, if you are using RTC products with Int user IDs, set this value as 'false'. Otherwise errors might occur.

◆ multipath

- (BOOL) multipath
readwritenonatomicassign

Whether to enable multipath, introduced from 2.2.0, for now , only effect on stream channel.

◆ logConfig

- (AgoraRtmLogConfig*) logConfig
readwritenonatomiccopy

The config for customer set log path, log size and log level.

◆ proxyConfig

- (AgoraRtmProxyConfig*) proxyConfig
readwritenonatomiccopy

The config for proxy setting

◆ encryptionConfig

- (AgoraRtmEncryptionConfig*) encryptionConfig
readwritenonatomiccopy

The config for encryption setting

◆ privateConfig

- (AgoraRtmPrivateConfig*) privateConfig
readwritenonatomiccopy

The config for private setting