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 %}