floo2
Public Member Functions | Static Public Member Functions | List of all members
floo::BMXClient Class Referenceabstract

客户端 More...

#include <bmx_client.h>

Inheritance diagram for floo::BMXClient:
floo::BMXNetworkListener

Public Member Functions

virtual ~BMXClient ()
 析构函数
 
virtual BMXSDKConfigPtr getSDKConfig ()=0
 获取SDK设置 More...
 
virtual BMXUserServicegetUserService ()=0
 获取用户Service More...
 
virtual BMXChatServicegetChatService ()=0
 获取聊天Service More...
 
virtual BMXGroupServicegetGroupService ()=0
 获取群组Service More...
 
virtual BMXRosterServicegetRosterService ()=0
 获取好友Service More...
 
virtual BMXPushServicegetPushService ()=0
 获取推送Service More...
 
virtual BMXErrorCode signUpNewUser (const std::string &username, const std::string &password, BMXUserProfilePtr &bmxUserProfilePtr)=0
 注册新用户,username和password是必填参数 More...
 
virtual BMXErrorCode signInByName (const std::string &name, const std::string &password)=0
 通过用户名登录 More...
 
virtual BMXErrorCode signInById (int64_t, const std::string &password)=0
 通过用户ID登录 More...
 
virtual BMXErrorCode fastSignInByName (const std::string &name, const std::string &password)=0
 通过用户名快速登录(要求之前成功登录过,登录速度较快) More...
 
virtual BMXErrorCode fastSignInById (int64_t uid, const std::string &password)=0
 通过用户ID快速登录(要求之前成功登录过,登录速度较快) More...
 
virtual BMXErrorCode signOut (int64_t uid=0, bool ignoreUnbindDevice=false)=0
 退出登录 More...
 
virtual BMXConnectStatus connectStatus ()=0
 获取当前和服务器的连接状态 More...
 
virtual BMXSignInStatus signInStatus ()=0
 获取当前的登录状态 More...
 
virtual void reconnect ()=0
 强制重新连接
 
virtual void onNetworkChanged (BMXNetworkType type, bool reconnect)=0
 处理网络状态发送变化 More...
 
virtual void disconnect ()=0
 断开网络连接
 
virtual BMXErrorCode changeAppId (const std::string &appId, const std::string &appSecret="")=0
 更改SDK的appId,本操作会同时更新BMXConfig中的appId。 More...
 
virtual BMXErrorCode initializeServerConfig (bool isLocal)=0
 获取app的服务器网络配置,在初始化SDK之后登陆之前调用,可以提前获取服务器配置加快登陆速度。 More...
 
virtual void sendMessage (BMXMessagePtr msg)=0
 发送消息,消息状态变化会通过listener通知,在发送群组消息且指定的群组为开启群组已读回执的情况下, 该接口会自动获取群成员列表id并且填充到message config中去,无需客户端自己进行群组成员列表的填充操作。 More...
 

Static Public Member Functions

static BMXClientPtr create (BMXSDKConfigPtr config)
 创建BMXClient More...
 

Detailed Description

客户端

Member Function Documentation

◆ changeAppId()

virtual BMXErrorCode floo::BMXClient::changeAppId ( const std::string &  appId,
const std::string &  appSecret = "" 
)
pure virtual

更改SDK的appId,本操作会同时更新BMXConfig中的appId。

Parameters
appId新变更的appId
Returns
BMXErrorCode

◆ connectStatus()

virtual BMXConnectStatus floo::BMXClient::connectStatus ( )
pure virtual

获取当前和服务器的连接状态

Returns
BMXConnectStatus

◆ create()

static BMXClientPtr floo::BMXClient::create ( BMXSDKConfigPtr  config)
static

创建BMXClient

Parameters
config客户端本地已经创建好的BMXSDKConfig SDK配置对象
Returns
BMXClientPtr

◆ fastSignInById()

virtual BMXErrorCode floo::BMXClient::fastSignInById ( int64_t  uid,
const std::string &  password 
)
pure virtual

通过用户ID快速登录(要求之前成功登录过,登录速度较快)

Parameters
uid用户id
password用户密码(用于sdk在内部token到期时自动更新用户token)
Returns
BMXErrorCode

◆ fastSignInByName()

virtual BMXErrorCode floo::BMXClient::fastSignInByName ( const std::string &  name,
const std::string &  password 
)
pure virtual

通过用户名快速登录(要求之前成功登录过,登录速度较快)

Parameters
name用户名
password用户密码(用于sdk在内部token到期时自动更新用户token)
Returns
BMXErrorCode

◆ getChatService()

virtual BMXChatService& floo::BMXClient::getChatService ( )
pure virtual

获取聊天Service

Returns
BMXChatService

◆ getGroupService()

virtual BMXGroupService& floo::BMXClient::getGroupService ( )
pure virtual

获取群组Service

Returns
BMXGroupService

◆ getPushService()

virtual BMXPushService& floo::BMXClient::getPushService ( )
pure virtual

获取推送Service

Returns
BMXPushService

◆ getRosterService()

virtual BMXRosterService& floo::BMXClient::getRosterService ( )
pure virtual

获取好友Service

Returns
BMXRosterService

◆ getSDKConfig()

virtual BMXSDKConfigPtr floo::BMXClient::getSDKConfig ( )
pure virtual

获取SDK设置

Returns
BMXSDKConfigPtr

◆ getUserService()

virtual BMXUserService& floo::BMXClient::getUserService ( )
pure virtual

获取用户Service

Returns
BMXUserService

◆ initializeServerConfig()

virtual BMXErrorCode floo::BMXClient::initializeServerConfig ( bool  isLocal)
pure virtual

获取app的服务器网络配置,在初始化SDK之后登陆之前调用,可以提前获取服务器配置加快登陆速度。

Parameters
isLocal为true则使用本地缓存的dns配置,为false则从服务器获取最新的配置。
Returns
BMXErrorCode

◆ onNetworkChanged()

virtual void floo::BMXClient::onNetworkChanged ( BMXNetworkType  type,
bool  reconnect 
)
pure virtual

处理网络状态发送变化

Parameters
type变化后的网络类型
reconnect网络是否需要重连

Implements floo::BMXNetworkListener.

◆ sendMessage()

virtual void floo::BMXClient::sendMessage ( BMXMessagePtr  msg)
pure virtual

发送消息,消息状态变化会通过listener通知,在发送群组消息且指定的群组为开启群组已读回执的情况下, 该接口会自动获取群成员列表id并且填充到message config中去,无需客户端自己进行群组成员列表的填充操作。

Parameters
msg发送的消息

◆ signInById()

virtual BMXErrorCode floo::BMXClient::signInById ( int64_t  ,
const std::string &  password 
)
pure virtual

通过用户ID登录

Parameters
int64_t用户id
password用户密码
Returns
BMXErrorCode

◆ signInByName()

virtual BMXErrorCode floo::BMXClient::signInByName ( const std::string &  name,
const std::string &  password 
)
pure virtual

通过用户名登录

Parameters
name用户名
password用户密码
Returns
BMXErrorCode

◆ signInStatus()

virtual BMXSignInStatus floo::BMXClient::signInStatus ( )
pure virtual

获取当前的登录状态

Returns
BMXSignInStatus

◆ signOut()

virtual BMXErrorCode floo::BMXClient::signOut ( int64_t  uid = 0,
bool  ignoreUnbindDevice = false 
)
pure virtual

退出登录

Parameters
uid退出用户的uid(默认输入0则退出当前登陆用户)
ignoreUnbindDevice用户退出时是否忽略解绑定设备操作。对应某些服务器不可访问的情况下忽略服务器解绑定设备操作直接强制退出时设置为true
Returns
BMXErrorCode

◆ signUpNewUser()

virtual BMXErrorCode floo::BMXClient::signUpNewUser ( const std::string &  username,
const std::string &  password,
BMXUserProfilePtr &  bmxUserProfilePtr 
)
pure virtual

注册新用户,username和password是必填参数

Parameters
username用户名
password用户密码
bmxUserProfilePtr注册成功后从该函数处获取新注册用户的Profile信息,初始传入指向为空的shared_ptr对象即可。
Returns
BMXErrorCode

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