floo2
Classes | Public Member Functions | List of all members
floo::BMXSDKConfig Class Reference

SDK设置管理 More...

#include <bmx_sdk_config.h>

Classes

struct  HostConfig
 服务设置 More...
 

Public Member Functions

 BMXSDKConfig (BMXClientType type, const std::string &vsn, const std::string &dataDir, const std::string &cacheDir, const std::string &SDKVersion, const std::string &pushCertName, const std::string &userAgent, bool deliveryAck=false)
 构造函数 More...
 
 BMXSDKConfig (BMXClientType type, const std::string &vsn, const std::string &dataDir, const std::string &cacheDir, const std::string &SDKVersion, const std::string &pushCertName, const std::string &userAgent, const std::string &appId, const std::string &appSecret, bool deliveryAck=false)
 构造函数 More...
 
virtual ~BMXSDKConfig ()
 析构函数
 
const std::string & getDataDir ()
 获取聊天数据存储路径,包含消息、附件等 More...
 
const std::string & getCacheDir ()
 获取缓存数据存储路径,比如用户头像 More...
 
BMXClientType getClientType ()
 客户端类型 More...
 
const std::string & getVsn ()
 客户端OS版本 More...
 
const std::string & getSDKVersion ()
 SDK版本 More...
 
const std::string & getPushCertName ()
 获取Push证书名字 More...
 
void setPushCertName (const std::string &)
 设置Push证书名字 More...
 
const std::string & getUserAgent ()
 获取用户代理信息 More...
 
bool enableDeliveryAck ()
 是否发送消息送达回执 More...
 
void setEnableDeliveryAck (bool)
 设置是否发送消息送达回执 More...
 
BMXLogLevel getLogLevel ()
 Log输出等级 More...
 
void setLogLevel (BMXLogLevel)
 设置Log输出等级 More...
 
bool getConsoleOutput ()
 Log是否输出到Console. More...
 
void setConsoleOutput (bool)
 设置Log是否输出到Console More...
 
void setHostConfig (const HostConfig &config)
 设置服务器配置 More...
 
const HostConfiggetHostConfig ()
 获取服务器配置 More...
 
bool getLoadAllServerConversations ()
 是否根据服务器返回未读列表创建所有会话. More...
 
void setLoadAllServerConversations (bool enable=false)
 是否根据服务器返回未读列表创建所有会话,默认为false,只会创建有未读消息的会话。 More...
 
const std::string & getDeviceUuid ()
 获取设备的唯一识别码 More...
 
void setDeviceUuid (const std::string &uuid)
 设置设备的唯一识别码,在app卸载之前应该始终保持一致,app删除后再次安装时可以产生不同的设备识别码。用于本地数据库加密。 More...
 
bool getVerifyCertificate ()
 获取https请求是否验证服务器端证书。 More...
 
void setVerifyCertificate (bool verify=true)
 
bool getEnableDNS ()
 获取是否启用dns功能。 More...
 
void setEnableDNS (bool enable=true)
 设置是否启用dns功能,默认是开启的。 More...
 
std::string getUserDNSAddress ()
 获取用户自定义dns服务器地址。 More...
 
void setUserDNSAddress (const std::string &dns)
 设置用户自定义dns服务器地址,在用户设置了dns服务器的情况下优先使用用户dns。 More...
 
std::string getAppID ()
 获取用户的appID。 More...
 
void setAppID (const std::string &appID)
 设置用户的appID。 More...
 
std::string getAppSecret ()
 获取用户的appSecret。 More...
 
void setAppSecret (const std::string &appSecret)
 设置用户的appSecret。 More...
 
BMXPushProviderType getPushProviderType ()
 获取用户的推送提供商类型。 More...
 
void setPushProviderType (BMXPushProviderType type)
 设置用户的推送提供商类型。 More...
 
BMXPushEnvironmentType getPushEnvironmentType ()
 获取用户的推送环境类型。 More...
 
void setEnvironmentType (BMXPushEnvironmentType type)
 设置用户的推送环境类型。 More...
 
int64_t getDebugLogReceiverId ()
 获取调试log接收着账号(仅用于SDK调试,接收客户端log日志使用) More...
 
void setDebugLogReceiverId (int64_t uid)
 设置调试log接收账号(仅用于SDK调试,接收客户端log日志使用) More...
 

Detailed Description

SDK设置管理

Constructor & Destructor Documentation

◆ BMXSDKConfig() [1/2]

floo::BMXSDKConfig::BMXSDKConfig ( BMXClientType  type,
const std::string &  vsn,
const std::string &  dataDir,
const std::string &  cacheDir,
const std::string &  SDKVersion,
const std::string &  pushCertName,
const std::string &  userAgent,
bool  deliveryAck = false 
)

构造函数

Parameters
type客户端类型
vsn客户端OS版本
dataDir聊天数据存储路径
cacheDir缓存数据存储路径
SDKVersionSDK版本
pushCertNamePush证书名字
userAgent用户代理信息
deliveryAck是否发送消息送达回执

◆ BMXSDKConfig() [2/2]

floo::BMXSDKConfig::BMXSDKConfig ( BMXClientType  type,
const std::string &  vsn,
const std::string &  dataDir,
const std::string &  cacheDir,
const std::string &  SDKVersion,
const std::string &  pushCertName,
const std::string &  userAgent,
const std::string &  appId,
const std::string &  appSecret,
bool  deliveryAck = false 
)

构造函数

Parameters
type客户端类型
vsn客户端OS版本
dataDir聊天数据存储路径
cacheDir缓存数据存储路径
SDKVersionSDK版本
pushCertNamePush证书名字
userAgent用户代理信息
appId用户的appId
appSecret用户的appSecret(对于使用推送的用户,必须同时设置appId和appSecret)
deliveryAck是否发送消息送达回执

Member Function Documentation

◆ enableDeliveryAck()

bool floo::BMXSDKConfig::enableDeliveryAck ( )

是否发送消息送达回执

Returns
bool

◆ getAppID()

std::string floo::BMXSDKConfig::getAppID ( )

获取用户的appID。

Returns
std::string

◆ getAppSecret()

std::string floo::BMXSDKConfig::getAppSecret ( )

获取用户的appSecret。

Returns
std::string

◆ getCacheDir()

const std::string& floo::BMXSDKConfig::getCacheDir ( )

获取缓存数据存储路径,比如用户头像

Returns
std::string

◆ getClientType()

BMXClientType floo::BMXSDKConfig::getClientType ( )

客户端类型

Returns
BMXClientType

◆ getConsoleOutput()

bool floo::BMXSDKConfig::getConsoleOutput ( )

Log是否输出到Console.

Returns
bool

◆ getDataDir()

const std::string& floo::BMXSDKConfig::getDataDir ( )

获取聊天数据存储路径,包含消息、附件等

Returns
std::string

◆ getDebugLogReceiverId()

int64_t floo::BMXSDKConfig::getDebugLogReceiverId ( )

获取调试log接收着账号(仅用于SDK调试,接收客户端log日志使用)

Returns
int64_t

◆ getDeviceUuid()

const std::string& floo::BMXSDKConfig::getDeviceUuid ( )

获取设备的唯一识别码

Returns
std::string

◆ getEnableDNS()

bool floo::BMXSDKConfig::getEnableDNS ( )

获取是否启用dns功能。

Returns
bool

◆ getHostConfig()

const HostConfig& floo::BMXSDKConfig::getHostConfig ( )

获取服务器配置

Returns
HostConfig

◆ getLoadAllServerConversations()

bool floo::BMXSDKConfig::getLoadAllServerConversations ( )

是否根据服务器返回未读列表创建所有会话.

Returns
bool

◆ getLogLevel()

BMXLogLevel floo::BMXSDKConfig::getLogLevel ( )

Log输出等级

Returns
BMXLogLevel

◆ getPushCertName()

const std::string& floo::BMXSDKConfig::getPushCertName ( )

获取Push证书名字

Returns
std::string

◆ getPushEnvironmentType()

BMXPushEnvironmentType floo::BMXSDKConfig::getPushEnvironmentType ( )

获取用户的推送环境类型。

Returns
BMXPushEnvironmentType

◆ getPushProviderType()

BMXPushProviderType floo::BMXSDKConfig::getPushProviderType ( )

获取用户的推送提供商类型。

Returns
BMXPushProviderType

◆ getSDKVersion()

const std::string& floo::BMXSDKConfig::getSDKVersion ( )

SDK版本

Returns
std::string

◆ getUserAgent()

const std::string& floo::BMXSDKConfig::getUserAgent ( )

获取用户代理信息

Returns
std::string

◆ getUserDNSAddress()

std::string floo::BMXSDKConfig::getUserDNSAddress ( )

获取用户自定义dns服务器地址。

Returns
std::string

◆ getVerifyCertificate()

bool floo::BMXSDKConfig::getVerifyCertificate ( )

获取https请求是否验证服务器端证书。

Returns
bool

◆ getVsn()

const std::string& floo::BMXSDKConfig::getVsn ( )

客户端OS版本

Returns
std::string

◆ setAppID()

void floo::BMXSDKConfig::setAppID ( const std::string &  appID)

设置用户的appID。

Parameters
appID用户的appID

◆ setAppSecret()

void floo::BMXSDKConfig::setAppSecret ( const std::string &  appSecret)

设置用户的appSecret。

Parameters
appID用户的appSecret

◆ setConsoleOutput()

void floo::BMXSDKConfig::setConsoleOutput ( bool  )

设置Log是否输出到Console

Parameters
bool设置Log是否输出到Console

◆ setDebugLogReceiverId()

void floo::BMXSDKConfig::setDebugLogReceiverId ( int64_t  uid)

设置调试log接收账号(仅用于SDK调试,接收客户端log日志使用)

Parameters
uid调试log接收者id

◆ setDeviceUuid()

void floo::BMXSDKConfig::setDeviceUuid ( const std::string &  uuid)

设置设备的唯一识别码,在app卸载之前应该始终保持一致,app删除后再次安装时可以产生不同的设备识别码。用于本地数据库加密。

Parameters
uuid设备的唯一识别码。

◆ setEnableDeliveryAck()

void floo::BMXSDKConfig::setEnableDeliveryAck ( bool  )

设置是否发送消息送达回执

Parameters
bool是否发送消息送达回执

◆ setEnableDNS()

void floo::BMXSDKConfig::setEnableDNS ( bool  enable = true)

设置是否启用dns功能,默认是开启的。

Parameters
enable是否启用dns功能

◆ setEnvironmentType()

void floo::BMXSDKConfig::setEnvironmentType ( BMXPushEnvironmentType  type)

设置用户的推送环境类型。

Parameters
type用户的推送环境类型

◆ setHostConfig()

void floo::BMXSDKConfig::setHostConfig ( const HostConfig config)

设置服务器配置

Parameters
config服务器配置

◆ setLoadAllServerConversations()

void floo::BMXSDKConfig::setLoadAllServerConversations ( bool  enable = false)

是否根据服务器返回未读列表创建所有会话,默认为false,只会创建有未读消息的会话。

Parameters
enable是否根据服务器返回未读列表创建所有会话

◆ setLogLevel()

void floo::BMXSDKConfig::setLogLevel ( BMXLogLevel  )

设置Log输出等级

Parameters
BMXLogLevelLog输出等级

◆ setPushCertName()

void floo::BMXSDKConfig::setPushCertName ( const std::string &  )

设置Push证书名字

Returns
std::string

◆ setPushProviderType()

void floo::BMXSDKConfig::setPushProviderType ( BMXPushProviderType  type)

设置用户的推送提供商类型。

Parameters
type用户的推送提供商类型

◆ setUserDNSAddress()

void floo::BMXSDKConfig::setUserDNSAddress ( const std::string &  dns)

设置用户自定义dns服务器地址,在用户设置了dns服务器的情况下优先使用用户dns。

Parameters
dns用户自定义dns服务器地址

◆ setVerifyCertificate()

void floo::BMXSDKConfig::setVerifyCertificate ( bool  verify = true)

设置https请求是否验证服务器端证书。

Parameters
verifyhttps请求是否验证服务器端证书

The documentation for this class was generated from the following file: