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:

dealloc#

- (void)dealloc

Example:

enableDeliveryAck#

Whether to send message delivery receipts

- (BOOL)enableDeliveryAck

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

getAppID#

Get the app ID

- (NSString *)getAppID

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getAppSecret#

Get app secret

- (NSString *)getAppSecret

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getCacheDir#

Get cache files directory

- (NSString *)getCacheDir

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getClientType#

Get client device type

- (BMXClientType)getClientType

Return Value#

BMXClientType

Declared In#

floo_proxy.h

Example:

getConsoleOutput#

Get the switch of whether to output the log to console

- (BOOL)getConsoleOutput

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

getDBCryptoKey#

Get crypto key of local db

- (NSString *)getDBCryptoKey

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getDataDir#

Get data files directory

- (NSString *)getDataDir

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getDebugLogReceiverId#

Get debug log files receiver ID

- (long long)getDebugLogReceiverId

Return Value#

long long

Declared In#

floo_proxy.h

Example:

getDeviceUuid#

Get device UUID

- (NSString *)getDeviceUuid

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getEnableDNS#

Get whether to enable DNS on ratel

- (BOOL)getEnableDNS

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

getHostConfig#

Get server hosts information

- (BMXSDKConfigHostConfig *)getHostConfig

Return Value#

BMXSDKConfigHostConfig

Declared In#

floo_proxy.h

Example:

getLoadAllServerConversations#

Whether to generate conversation list from server

- (BOOL)getLoadAllServerConversations

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

getLogLevel#

Log level

- (BMXLogLevel)getLogLevel

Return Value#

BMXLogLevel

Declared In#

floo_proxy.h

Example:

getPushCertName#

Get the push certificate name

- (NSString *)getPushCertName

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getPushEnvironmentType#

Get user's Push environment type.

- (BMXPushEnvironmentType)getPushEnvironmentType

Return Value#

BMXPushEnvironmentType

Declared In#

floo_proxy.h

Example:

getPushProviderType#

Get push service provider type

- (BMXPushProviderType)getPushProviderType

Return Value#

BMXPushProviderType

Declared In#

floo_proxy.h

Example:

getSDKVersion#

Get SDK version

- (NSString *)getSDKVersion

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getUserAgent#

Get user agent

- (NSString *)getUserAgent

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getUserDNSAddress#

Get custom DNS address

- (NSString *)getUserDNSAddress

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

getVerifyCertificate#

Get whether to verify HTTP certificate

- (BOOL)getVerifyCertificate

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

getVsn#

Ge app client version

- (NSString *)getVsn

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

initWithCptr:swigOwnCObject:#

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

Example:

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:

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

Example:

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

Constructor

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:

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

Constructor

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:

setAppID:#

Set app ID

- (void)setAppID:(NSString )appID*

Parameters#

appID
App ID

Declared In#

floo_proxy.h

Example:

setAppSecret:#

Set app secret

- (void)setAppSecret:(NSString )appSecret*

Parameters#

appID
App secret

Declared In#

floo_proxy.h

Example:

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:

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:

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:

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:

setDeviceUuid:#

Set device UUID

- (void)setDeviceUuid:(NSString )uuid*

Parameters#

uuid
Unique device identifier.

Declared In#

floo_proxy.h

Example:

setEnableDNS#

- (void)setEnableDNS

Example:

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:

setEnableDeliveryAck:#

Enable delivery ACK

- (void)setEnableDeliveryAck:(BOOL)arg1

Parameters#

bool
Whether to send message delivery receipts

Declared In#

floo_proxy.h

Example:

setEnvironmentType:#

Set user's Push environment type.

- (void)setEnvironmentType:(BMXPushEnvironmentType)type

Parameters#

type
The user's push environment

Declared In#

floo_proxy.h

Example:

setHostConfig:#

Set server hosts config

- (void)setHostConfig:(BMXSDKConfigHostConfig )config*

Parameters#

config
Server configuration

Declared In#

floo_proxy.h

Example:

setLoadAllServerConversations#

- (void)setLoadAllServerConversations

Example:

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:

setLogLevel:#

Set log level

- (void)setLogLevel:(BMXLogLevel)arg1

Parameters#

BMXLogLevel
Log level

Declared In#

floo_proxy.h

Example:

setPushCertName:#

Set the push certificate name

- (void)setPushCertName:(NSString )arg1*

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

setPushProviderType:#

Set push service provider type

- (void)setPushProviderType:(BMXPushProviderType)type

Parameters#

type
Push provider type

Declared In#

floo_proxy.h

Example:

setUserDNSAddress:#

Set custom DNS address

- (void)setUserDNSAddress:(NSString )dns*

Parameters#

dns
DNS server address

Declared In#

floo_proxy.h

Example:

setVerifyCertificate#

- (void)setVerifyCertificate

Example:

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