BMXSDKConfig Class Reference#

Inherits from NSObject
Declared in floo_proxy.h

Overview#

@interface SDK config

Properties#

swigCMemOwn#

@property (nonatomic) BOOL swigCMemOwn

swigCPtr#

@property (nonatomic) void *swigCPtr

Instance Methods#

carryUsernameInMessage#

Whether to carry the username in the message

- (BOOL)carryUsernameInMessage

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="carryUsernameInMessage" %}{% endlanying_code_snippet %}

dealloc#

- (void)dealloc

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="dealloc" %}{% endlanying_code_snippet %}

enableDeliveryAck#

Whether to send message delivery receipts

- (BOOL)enableDeliveryAck

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="enableDeliveryAck" %}{% endlanying_code_snippet %}

getAppID#

Get the app ID

- (NSString *)getAppID

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getAppID" %}{% endlanying_code_snippet %}

getAppSecret#

Get app secret

- (NSString *)getAppSecret

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getAppSecret" %}{% endlanying_code_snippet %}

getCacheDir#

Get cache files directory

- (NSString *)getCacheDir

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getCacheDir" %}{% endlanying_code_snippet %}

getClientType#

Get client device type

- (BMXClientType)getClientType

Return Value#

BMXClientType

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getClientType" %}{% endlanying_code_snippet %}

getConsoleOutput#

Get the switch of whether to output the log to console

- (BOOL)getConsoleOutput

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getConsoleOutput" %}{% endlanying_code_snippet %}

getDBCryptoKey#

Get crypto key of local db

- (NSString *)getDBCryptoKey

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getDBCryptoKey" %}{% endlanying_code_snippet %}

getDataDir#

Get data files directory

- (NSString *)getDataDir

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getDataDir" %}{% endlanying_code_snippet %}

getDebugLogReceiverId#

Get debug log files receiver ID

- (long long)getDebugLogReceiverId

Return Value#

long long

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getDebugLogReceiverId" %}{% endlanying_code_snippet %}

getDeviceUuid#

Get device UUID

- (NSString *)getDeviceUuid

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getDeviceUuid" %}{% endlanying_code_snippet %}

getEnableDNS#

Get whether to enable DNS on ratel

- (BOOL)getEnableDNS

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getEnableDNS" %}{% endlanying_code_snippet %}

getHostConfig#

Get server hosts information

- (BMXSDKConfigHostConfig *)getHostConfig

Return Value#

BMXSDKConfigHostConfig

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getHostConfig" %}{% endlanying_code_snippet %}

getLoadAllServerConversations#

Whether to generate conversation list from server

- (BOOL)getLoadAllServerConversations

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getLoadAllServerConversations" %}{% endlanying_code_snippet %}

getLogLevel#

Log level

- (BMXLogLevel)getLogLevel

Return Value#

BMXLogLevel

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getLogLevel" %}{% endlanying_code_snippet %}

getPushCertName#

Get the push certificate name

- (NSString *)getPushCertName

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getPushCertName" %}{% endlanying_code_snippet %}

getPushEnvironmentType#

Get user's Push environment type.

- (BMXPushEnvironmentType)getPushEnvironmentType

Return Value#

BMXPushEnvironmentType

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getPushEnvironmentType" %}{% endlanying_code_snippet %}

getPushProviderType#

Get push service provider type

- (BMXPushProviderType)getPushProviderType

Return Value#

BMXPushProviderType

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getPushProviderType" %}{% endlanying_code_snippet %}

getSDKVersion#

Get SDK version

- (NSString *)getSDKVersion

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getSDKVersion" %}{% endlanying_code_snippet %}

getUserAgent#

Get user agent

- (NSString *)getUserAgent

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getUserAgent" %}{% endlanying_code_snippet %}

getUserDNSAddress#

Get custom DNS address

- (NSString *)getUserDNSAddress

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getUserDNSAddress" %}{% endlanying_code_snippet %}

getVerifyCertificate#

Get whether to verify HTTP certificate

- (BOOL)getVerifyCertificate

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getVerifyCertificate" %}{% endlanying_code_snippet %}

getVsn#

Ge app client version

- (NSString *)getVsn

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="getVsn" %}{% endlanying_code_snippet %}

initWithCptr:swigOwnCObject:#

- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="initWithCptr:swigOwnCObject:" %}{% endlanying_code_snippet %}

initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:#

- (id)initWithType:(BMXClientType)type vsn:(NSString )vsn dataDir:(NSString )dataDir cacheDir:(NSString )cacheDir sDKVersion:(NSString )SDKVersion pushCertName:(NSString )pushCertName userAgent:(NSString )userAgent

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:" %}{% endlanying_code_snippet %}

initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:appId:appSecret:#

- (id)initWithType:(BMXClientType)type vsn:(NSString )vsn dataDir:(NSString )dataDir cacheDir:(NSString )cacheDir sDKVersion:(NSString )SDKVersion pushCertName:(NSString )pushCertName userAgent:(NSString )userAgent appId:(NSString )appId appSecret:(NSString )appSecret

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:appId:appSecret:" %}{% endlanying_code_snippet %}

initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:appId:appSecret:deliveryAck:#

Constructor

- (id)initWithType:(BMXClientType)type vsn:(NSString )vsn dataDir:(NSString )dataDir cacheDir:(NSString )cacheDir sDKVersion:(NSString )SDKVersion pushCertName:(NSString )pushCertName userAgent:(NSString )userAgent appId:(NSString )appId appSecret:(NSString )appSecret deliveryAck:(BOOL)deliveryAck

Parameters#

type
Client type

vsn
App client version

dataDir
Data files directory

cacheDir
Cache files directory

SDKVersion
SDK version

pushCertName
Push certificate name

userAgent
User agent

appId
App ID

appSecret
App secret

deliveryAck
Whether to send message delivery receipts

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:appId:appSecret:deliveryAck:" %}{% endlanying_code_snippet %}

initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:deliveryAck:#

Constructor

- (id)initWithType:(BMXClientType)type vsn:(NSString )vsn dataDir:(NSString )dataDir cacheDir:(NSString )cacheDir sDKVersion:(NSString )SDKVersion pushCertName:(NSString )pushCertName userAgent:(NSString )userAgent deliveryAck:(BOOL)deliveryAck

Parameters#

type
Client type

vsn
App client version

dataDir
Data files directory

cacheDir
Cache files directory

SDKVersion
SDK version

pushCertName
Push certificate name

userAgent
User agent

deliveryAck
Whether to send message delivery receipts

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="initWithType:vsn:dataDir:cacheDir:sDKVersion:pushCertName:userAgent:deliveryAck:" %}{% endlanying_code_snippet %}

setAppID:#

Set app ID

- (void)setAppID:(NSString )appID*

Parameters#

appID
App ID

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setAppID:" %}{% endlanying_code_snippet %}

setAppSecret:#

Set app secret

- (void)setAppSecret:(NSString )appSecret*

Parameters#

appID
App secret

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setAppSecret:" %}{% endlanying_code_snippet %}

setCarryUsernameInMessage:#

Set whether to carry the username in the message

- (void)setCarryUsernameInMessage:(BOOL)arg1

Parameters#

bool
Whether to include the username in the message config

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setCarryUsernameInMessage:" %}{% endlanying_code_snippet %}

setConsoleOutput:#

Whether to write logs to the console

- (void)setConsoleOutput:(BOOL)arg1

Parameters#

bool
Whether to write logs to the console

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setConsoleOutput:" %}{% endlanying_code_snippet %}

setDBCryptoKey:#

Set crypto key of local db

- (void)setDBCryptoKey:(NSString )cryptoKey*

Parameters#

cryptoKey
Encryption key for the local database.

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setDBCryptoKey:" %}{% endlanying_code_snippet %}

setDebugLogReceiverId:#

Set debug log files receiver ID

- (void)setDebugLogReceiverId:(long long)uid

Parameters#

uid
Recipient ID for debug logs

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setDebugLogReceiverId:" %}{% endlanying_code_snippet %}

setDeviceUuid:#

Set device UUID

- (void)setDeviceUuid:(NSString )uuid*

Parameters#

uuid
Unique device identifier.

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setDeviceUuid:" %}{% endlanying_code_snippet %}

setEnableDNS#

- (void)setEnableDNS

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setEnableDNS" %}{% endlanying_code_snippet %}

setEnableDNS:#

Set whether to enable the delivery ACK

- (void)setEnableDNS:(BOOL)enable

Parameters#

enable
Whether to enable DNS resolution

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setEnableDNS:" %}{% endlanying_code_snippet %}

setEnableDeliveryAck:#

Enable delivery ACK

- (void)setEnableDeliveryAck:(BOOL)arg1

Parameters#

bool
Whether to send message delivery receipts

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setEnableDeliveryAck:" %}{% endlanying_code_snippet %}

setEnvironmentType:#

Set user's Push environment type.

- (void)setEnvironmentType:(BMXPushEnvironmentType)type

Parameters#

type
The user's push environment

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setEnvironmentType:" %}{% endlanying_code_snippet %}

setHostConfig:#

Set server hosts config

- (void)setHostConfig:(BMXSDKConfigHostConfig )config*

Parameters#

config
Server configuration

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setHostConfig:" %}{% endlanying_code_snippet %}

setLoadAllServerConversations#

- (void)setLoadAllServerConversations

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setLoadAllServerConversations" %}{% endlanying_code_snippet %}

setLoadAllServerConversations:#

Set whether to generate conversation list from server

- (void)setLoadAllServerConversations:(BOOL)enable

Parameters#

enable
Whether to create all conversations from the unread list returned by the server

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setLoadAllServerConversations:" %}{% endlanying_code_snippet %}

setLogLevel:#

Set log level

- (void)setLogLevel:(BMXLogLevel)arg1

Parameters#

BMXLogLevel
Log level

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setLogLevel:" %}{% endlanying_code_snippet %}

setPushCertName:#

Set the push certificate name

- (void)setPushCertName:(NSString )arg1*

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setPushCertName:" %}{% endlanying_code_snippet %}

setPushProviderType:#

Set push service provider type

- (void)setPushProviderType:(BMXPushProviderType)type

Parameters#

type
Push provider type

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setPushProviderType:" %}{% endlanying_code_snippet %}

setUserDNSAddress:#

Set custom DNS address

- (void)setUserDNSAddress:(NSString )dns*

Parameters#

dns
DNS server address

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setUserDNSAddress:" %}{% endlanying_code_snippet %}

setVerifyCertificate#

- (void)setVerifyCertificate

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setVerifyCertificate" %}{% endlanying_code_snippet %}

setVerifyCertificate:#

Set whether to verify HTTP certificate

- (void)setVerifyCertificate:(BOOL)verify

Parameters#

verify
true to verify

Discussion#

Set whether to verify HTTP certificate

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXSDKConfig",function="setVerifyCertificate:" %}{% endlanying_code_snippet %}