Easemob Windows SDK
Public Types | Public Member Functions | List of all members
easemob::EMChatConfigs Class Reference
Collaboration diagram for easemob::EMChatConfigs:
Collaboration graph

Public Types

enum  OSType {
  OS_IOS = 0, OS_ANDROID = 1, OS_LINUX = 2, OS_OSX = 3,
  OS_MSWIN = 4, OS_OTHER = 16
}
 
enum  EMLogLevel { DEBUG_LEVEL, WARNING_LEVEL, ERROR_LEVEL }
 

Public Member Functions

 EMChatConfigs (const std::string &resourcePath, const std::string &workPath, const std::string &appkey, unsigned int deviceId=0)
 
void setUsingHttps (bool usingHttps)
 
bool getUsingHttps ()
 
void setUseEncryption (bool useEncryption)
 
bool getUseEncryption ()
 
void setSortMessageByServerTime (bool sortByServerTime)
 
bool getSortMessageByServerTime ()
 
void setNetCallback (const EMNetCallbackPtr callback)
 
EMNetCallbackPtr getNetCallback ()
 
const std::string & getResourcePath () const
 Get the resource path. More...
 
const std::string & getWorkPath () const
 Get the work path. More...
 
void setLogPath (const std::string &path)
 Set the log path. More...
 
const std::string & getLogPath () const
 
void setDownloadPath (const std::string &path)
 Set the download path. More...
 
const std::string & getDownloadPath () const
 
void setAppKey (const std::string &appKey)
 Set the app key. More...
 
const std::string & getAppKey () const
 
void setIsSandboxMode (bool b)
 set sandbox mode. More...
 
bool getIsSandboxMode () const
 get sandbox mode. More...
 
void setEnableConsoleLog (bool b)
 set if output the log to console. More...
 
bool getEnableConsoleLog () const
 get if output the log to console. More...
 
void setAutoAcceptFriend (bool b)
 set if auto accept friend invitation. More...
 
bool getAutoAcceptFriend () const
 get if auto accept friend invitation. More...
 
void setAutoAcceptGroup (bool b)
 set if auto accept group invitation. More...
 
bool getAutoAcceptGroup () const
 get if auto accept group invitation. More...
 
void setRequireReadAck (bool b)
 set if need message read ack. More...
 
bool getRequireReadAck () const
 get if need message read ack. More...
 
void setRequireDeliveryAck (bool b)
 set if need message delivery ack. More...
 
bool getRequireDeliveryAck () const
 get if need message delivery ack. More...
 
void setRequireServerAck (bool b)
 set if need message server receive ack. More...
 
bool getRequireServerAck () const
 get if need message server receive ack. More...
 
void setAutoConversationLoaded (bool b)
 set if need load all conversation when login. More...
 
bool getAutoConversationLoaded () const
 get if load all conversation when login. More...
 
void setDeleteMessageAsExitGroup (bool b)
 set if delete message when exit group. More...
 
bool getDeleteMessageAsExitGroup () const
 get if delete message when exit group. More...
 
void setIsChatroomOwnerLeaveAllowed (bool b)
 set if chatroom owner can leave. More...
 
bool getIsChatroomOwnerLeaveAllowed () const
 get if chatroom owner can leave. More...
 
void setNumOfMessageLoaded (int n)
 set the number of message load at first time. More...
 
int getNumOfMessageLoaded () const
 get the number of message load at first time. More...
 
void setOs (const OSType os)
 set os type. More...
 
OSType getOs () const
 get os type. More...
 
void setOsVersion (const std::string &version)
 set os version. More...
 
const std::string & getOsVersion () const
 get os version. More...
 
void setSdkVersion (const std::string &version)
 set sdk version. More...
 
const std::string & getSdkVersion () const
 get sdk version. More...
 
unsigned int getDeviceID () const
 get device unique id. More...
 
void setClientResource (const std::string &resource)
 set client resource More...
 
const std::string & clientResource ()
 get client resource More...
 
void setLogLevel (EMLogLevel level)
 Set log output level. More...
 
EMChatPrivateConfigs & privateConfigs ()
 
void setDeleteMessageAsExitChatRoom (bool b)
 
bool getDeleteMessageAsExitChatRoom ()
 

Member Function Documentation

§ clientResource()

const std::string& easemob::EMChatConfigs::clientResource ( )
inline

get client resource

Returns
resource

§ getAutoAcceptFriend()

bool easemob::EMChatConfigs::getAutoAcceptFriend ( ) const
inline

get if auto accept friend invitation.

Parameters
NA.
Returns
true or false.

§ getAutoAcceptGroup()

bool easemob::EMChatConfigs::getAutoAcceptGroup ( ) const
inline

get if auto accept group invitation.

Parameters
NA.
Returns
true or false.

§ getAutoConversationLoaded()

bool easemob::EMChatConfigs::getAutoConversationLoaded ( ) const
inline

get if load all conversation when login.

Parameters
NA.
Returns
true or false.

§ getDeleteMessageAsExitGroup()

bool easemob::EMChatConfigs::getDeleteMessageAsExitGroup ( ) const
inline

get if delete message when exit group.

Parameters
NA.
Returns
true or false.

§ getDeviceID()

unsigned int easemob::EMChatConfigs::getDeviceID ( ) const
inline

get device unique id.

Parameters
NA.
Returns
device unique id.

§ getEnableConsoleLog()

bool easemob::EMChatConfigs::getEnableConsoleLog ( ) const
inline

get if output the log to console.

Parameters
trueor false.
Returns
NA.

§ getIsChatroomOwnerLeaveAllowed()

bool easemob::EMChatConfigs::getIsChatroomOwnerLeaveAllowed ( ) const
inline

get if chatroom owner can leave.

Parameters
NA.
Returns
true or false.

§ getIsSandboxMode()

bool easemob::EMChatConfigs::getIsSandboxMode ( ) const
inline

get sandbox mode.

Parameters
NA.
Returns
true or false.

§ getNumOfMessageLoaded()

int easemob::EMChatConfigs::getNumOfMessageLoaded ( ) const
inline

get the number of message load at first time.

Default is 20.

Parameters

§ getOs()

OSType easemob::EMChatConfigs::getOs ( ) const
inline

get os type.

Parameters
NA.
Returns
os type.

§ getOsVersion()

const std::string& easemob::EMChatConfigs::getOsVersion ( ) const
inline

get os version.

Parameters
NA.
Returns
os version.

§ getRequireDeliveryAck()

bool easemob::EMChatConfigs::getRequireDeliveryAck ( ) const
inline

get if need message delivery ack.

Parameters
NA.
Returns
true or false.

§ getRequireReadAck()

bool easemob::EMChatConfigs::getRequireReadAck ( ) const
inline

get if need message read ack.

Parameters
NA.
Returns
true or false.

§ getRequireServerAck()

bool easemob::EMChatConfigs::getRequireServerAck ( ) const
inline

get if need message server receive ack.

Parameters
NA.
Returns
true or false.

§ getResourcePath()

const std::string& easemob::EMChatConfigs::getResourcePath ( ) const
inline

Get the resource path.

Parameters
NA.
Returns
resource path.

§ getSdkVersion()

const std::string& easemob::EMChatConfigs::getSdkVersion ( ) const
inline

get sdk version.

Parameters
NA.
Returns
sdk version.

§ getWorkPath()

const std::string& easemob::EMChatConfigs::getWorkPath ( ) const
inline

Get the work path.

Parameters
NA.
Returns
work path.

§ setAppKey()

void easemob::EMChatConfigs::setAppKey ( const std::string &  appKey)
inline

Set the app key.

Parameters
NA.
Returns
void.

§ setAutoAcceptFriend()

void easemob::EMChatConfigs::setAutoAcceptFriend ( bool  b)
inline

set if auto accept friend invitation.

Default is false.

Parameters
trueor false.
Returns
NA.

§ setAutoAcceptGroup()

void easemob::EMChatConfigs::setAutoAcceptGroup ( bool  b)
inline

set if auto accept group invitation.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setAutoConversationLoaded()

void easemob::EMChatConfigs::setAutoConversationLoaded ( bool  b)
inline

set if need load all conversation when login.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setClientResource()

void easemob::EMChatConfigs::setClientResource ( const std::string &  resource)
inline

set client resource

Parameters
resource

§ setDeleteMessageAsExitGroup()

void easemob::EMChatConfigs::setDeleteMessageAsExitGroup ( bool  b)
inline

set if delete message when exit group.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setDownloadPath()

void easemob::EMChatConfigs::setDownloadPath ( const std::string &  path)
inline

Set the download path.

Note: This path can't change in run time.

Parameters
NA.
Returns
void.

§ setEnableConsoleLog()

void easemob::EMChatConfigs::setEnableConsoleLog ( bool  b)
inline

set if output the log to console.

Default is false.

Parameters
trueor false.
Returns
NA.

§ setIsChatroomOwnerLeaveAllowed()

void easemob::EMChatConfigs::setIsChatroomOwnerLeaveAllowed ( bool  b)
inline

set if chatroom owner can leave.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setIsSandboxMode()

void easemob::EMChatConfigs::setIsSandboxMode ( bool  b)
inline

set sandbox mode.

Default is false.

Parameters
trueor false.
Returns
NA.

§ setLogLevel()

void easemob::EMChatConfigs::setLogLevel ( EMLogLevel  level)

Set log output level.

Parameters
logoutput level

§ setLogPath()

void easemob::EMChatConfigs::setLogPath ( const std::string &  path)
inline

Set the log path.

Note: This path can't change in run time.

Parameters
NA.
Returns
void.

§ setNumOfMessageLoaded()

void easemob::EMChatConfigs::setNumOfMessageLoaded ( int  n)
inline

set the number of message load at first time.

Default is 20.

Parameters
trueor false.
Returns
NA.

§ setOs()

void easemob::EMChatConfigs::setOs ( const OSType  os)
inline

set os type.

Parameters
ostype.
Returns
NA.

§ setOsVersion()

void easemob::EMChatConfigs::setOsVersion ( const std::string &  version)
inline

set os version.

Parameters
osversion.
Returns
NA.

§ setRequireDeliveryAck()

void easemob::EMChatConfigs::setRequireDeliveryAck ( bool  b)
inline

set if need message delivery ack.

Default is false.

Parameters
trueor false.
Returns
NA.

§ setRequireReadAck()

void easemob::EMChatConfigs::setRequireReadAck ( bool  b)
inline

set if need message read ack.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setRequireServerAck()

void easemob::EMChatConfigs::setRequireServerAck ( bool  b)
inline

set if need message server receive ack.

Default is true.

Parameters
trueor false.
Returns
NA.

§ setSdkVersion()

void easemob::EMChatConfigs::setSdkVersion ( const std::string &  version)
inline

set sdk version.

Parameters
sdkversion.
Returns
NA.

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