BMXSDKConfig Class Reference#

Inherits from NSObject
Declared in floo_proxy.h

Overview#

@interface SDK設定管理

Properties#

swigCMemOwn#

@property (nonatomic) BOOL swigCMemOwn

swigCPtr#

@property (nonatomic) void *swigCPtr

Instance Methods#

carryUsernameInMessage#

發送訊息的config中是否攜帶

- (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#

是否發送訊息送達回執

- (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#

取得使用者的appID。

- (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#

取得使用者的appSecret。

- (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#

取得緩存資料存儲路徑，比如使用者頭像

- (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#

客戶端類型

- (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#

Log是否輸出到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#

取得設備的本地資料庫加密密鑰。

- (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#

取得聊天資料存儲路徑，包含訊息、附件等

- (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#

取得調試log接收著賬號(僅用於SDK調試，接收客戶端log日誌使用)

- (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#

取得設備的唯一識別碼

- (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#

取得是否啟用dns功能。

- (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#

取得伺服器配置

- (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#

是否根據伺服器回傳未讀列表建立所有會話.

- (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輸出等級

- (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#

取得Push證書名字

- (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#

取得使用者的推播環境類型。

- (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#

取得使用者的推播提供商類型。

- (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#

SDK版本

- (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#

取得使用者代理信息

- (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#

取得使用者自定義dns伺服器地址。

- (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#

取得https請求是否驗證伺服器端證書。

- (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#

客戶端OS版本

- (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:#

構造函數

- (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
客戶端類型

vsn
客戶端OS版本

dataDir
聊天資料存儲路徑

cacheDir
緩存資料存儲路徑

SDKVersion
SDK版本

pushCertName
Push證書名字

userAgent
使用者代理信息

appId
使用者的appId

appSecret
使用者的appSecret（對於使用推播的使用者，必須同時設定appId和appSecret）

deliveryAck
是否發送訊息送達回執

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:#

構造函數

- (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
客戶端類型

vsn
客戶端OS版本

dataDir
聊天資料存儲路徑

cacheDir
緩存資料存儲路徑

SDKVersion
SDK版本

pushCertName
Push證書名字

userAgent
使用者代理信息

deliveryAck
是否發送訊息送達回執

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:#

設定使用者的appID。

- (void)setAppID:(NSString )appID*

Parameters#

appID
使用者的appID

Declared In#

• floo_proxy.h

Example:

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

setAppSecret:#

設定使用者的appSecret。

- (void)setAppSecret:(NSString )appSecret*

Parameters#

appID
使用者的appSecret

Declared In#

• floo_proxy.h

Example:

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

setCarryUsernameInMessage:#

設定發送訊息的config中是否攜帶使用者名

- (void)setCarryUsernameInMessage:(BOOL)arg1

Parameters#

bool
設定是否在送訊息的config中攜帶使用者名

Declared In#

• floo_proxy.h

Example:

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

setConsoleOutput:#

設定Log是否輸出到Console

- (void)setConsoleOutput:(BOOL)arg1

Parameters#

bool
設定Log是否輸出到Console

Declared In#

• floo_proxy.h

Example:

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

setDBCryptoKey:#

設定本地資料庫的加密密鑰，在app卸載之前應該始終保持一直，app刪除後再次安裝時可以產生不同的密鑰。用於本地資料庫加密。

- (void)setDBCryptoKey:(NSString )cryptoKey*

Parameters#

cryptoKey
本地資料庫的加密密鑰。

Declared In#

• floo_proxy.h

Example:

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

setDebugLogReceiverId:#

設定調試log接收賬號(僅用於SDK調試，接收客戶端log日誌使用)

- (void)setDebugLogReceiverId:(long long)uid

Parameters#

uid
調試log接收者id

Declared In#

• floo_proxy.h

Example:

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

setDeviceUuid:#

設定設備的唯一識別碼，在app卸載之前應該始終保持一致，app刪除後再次安裝時可以產生不同的設備識別碼。

- (void)setDeviceUuid:(NSString )uuid*

Parameters#

uuid
設備的唯一識別碼。

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:#

設定是否啟用dns功能，預設是開啟的。

- (void)setEnableDNS:(BOOL)enable

Parameters#

enable
是否啟用dns功能

Declared In#

• floo_proxy.h

Example:

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

setEnableDeliveryAck:#

設定是否發送訊息送達回執

- (void)setEnableDeliveryAck:(BOOL)arg1

Parameters#

bool
是否發送訊息送達回執

Declared In#

• floo_proxy.h

Example:

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

setEnvironmentType:#

設定使用者的推播環境類型。

- (void)setEnvironmentType:(BMXPushEnvironmentType)type

Parameters#

type
使用者的推播環境類型

Declared In#

• floo_proxy.h

Example:

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

setHostConfig:#

設定伺服器配置

- (void)setHostConfig:(BMXSDKConfigHostConfig )config*

Parameters#

config
伺服器配置

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:#

是否根據伺服器回傳未讀列表建立所有會話，預設為false，只會建立有未讀訊息的會話。

- (void)setLoadAllServerConversations:(BOOL)enable

Parameters#

enable
是否根據伺服器回傳未讀列表建立所有會話

Declared In#

• floo_proxy.h

Example:

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

setLogLevel:#

設定Log輸出等級

- (void)setLogLevel:(BMXLogLevel)arg1

Parameters#

BMXLogLevel
Log輸出等級

Declared In#

• floo_proxy.h

Example:

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

setPushCertName:#

設定Push證書名字

- (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:#

設定使用者的推播提供商類型。

- (void)setPushProviderType:(BMXPushProviderType)type

Parameters#

type
使用者的推播提供商類型

Declared In#

• floo_proxy.h

Example:

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

setUserDNSAddress:#

設定使用者自定義dns伺服器地址，在使用者設定了dns伺服器的情況下優先使用使用者dns。

- (void)setUserDNSAddress:(NSString )dns*

Parameters#

dns
使用者自定義dns伺服器地址

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:#

設定https請求是否驗證伺服器端證書。

- (void)setVerifyCertificate:(BOOL)verify

Parameters#

verify
https請求是否驗證伺服器端證書

Discussion#

設定https請求是否驗證伺服器端證書。

Declared In#

• floo_proxy.h

Example:

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