im::floo::floolib::BMXClient

客户端

Inherits from im.floo.floolib.BMXNetworkListener

Public Functions

Name

synchronized void

getSDKConfig() 获取SDK设置

getUserService() 获取用户Service

getChatService() 获取聊天Service

getGroupService() 获取群组Service

getRosterService() 获取好友Service

getPushService() 获取推送Service

getUserManager() 获取用户Manager

getChatManager() 获取聊天Manager

getGroupManager() 获取群组Manager

getRosterManager() 获取好友Manager

getPushManager() 获取推送Manager

[BMXErrorCode]

signUpNewUser(String username, String password, BMXUserProfile bmxUserProfilePtr) 注册新用户,username和password是必填参数

[BMXErrorCode]

signInByName(String name, String password) 通过用户名登录

[BMXErrorCode]

signInById(long arg0, String password) 通过用户ID登录

[BMXErrorCode]

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

[BMXErrorCode]

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

[BMXErrorCode]

signOut(long uid, boolean ignoreUnbindDevice) 退出登录

[BMXErrorCode]

signOut(long uid)

[BMXErrorCode]

[BMXConnectStatus]

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

[BMXSignInStatus]

signInStatus() 获取当前的登录状态

void

reconnect() 强制重新连接

void

onNetworkChanged([BMXNetworkType] type, boolean reconnect) 处理网络状态发送变化

void

disconnect() 断开网络连接

[BMXErrorCode]

changeAppId(String appId, String appSecret) 更改SDK的appId,本操作会同时更新BMXConfig中的appId。

[BMXErrorCode]

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

[BMXErrorCode]

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

void

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

create(BMXSDKConfig config) 创建BMXClient

Protected Functions

Name

BMXClient(long cPtr, boolean cMemoryOwn)

void

Additional inherited members

Public Functions inherited from im.floo.floolib.BMXNetworkListener

Protected Functions inherited from im.floo.floolib.BMXNetworkListener

Name

BMXNetworkListener(long cPtr, boolean cMemoryOwn)

Public Functions Documentation

function delete

Reimplements: im::floo::floolib::BMXNetworkListener::delete

function getSDKConfig

获取SDK设置

Return: BMXSDKConfigPtr

function getUserService

获取用户Service

Return: BMXUserService

function getChatService

获取聊天Service

Return: BMXChatService

function getGroupService

获取群组Service

Return: BMXGroupService

function getRosterService

获取好友Service

Return: BMXRosterService

function getPushService

获取推送Service

Return: BMXPushService

function getUserManager

获取用户Manager

Return: BMXUserManager

function getChatManager

获取聊天Manager

Return: BMXChatManager

function getGroupManager

获取群组Manager

Return: BMXGroupManager

function getRosterManager

获取好友Manager

Return: BMXRosterManager

function getPushManager

获取推送Manager

Return: BMXPushManager

function signUpNewUser

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

Parameters:

  • username 用户名

  • password 用户密码

  • bmxUserProfilePtr 注册成功后从该函数处获取新注册用户的Profile信息,初始传入指向为空的shared_ptr对象即可。

Return: [BMXErrorCode]

function signInByName

通过用户名登录

Parameters:

  • name 用户名

  • password 用户密码

Return: [BMXErrorCode]

function signInById

通过用户ID登录

Parameters:

  • arg0 用户id

  • password 用户密码

Return: [BMXErrorCode]

function fastSignInByName

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

Parameters:

  • name 用户名

  • password 用户密码(用于sdk在内部token到期时自动更新用户token)

Return: [BMXErrorCode]

function fastSignInById

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

Parameters:

  • uid 用户id

  • password 用户密码(用于sdk在内部token到期时自动更新用户token)

Return: [BMXErrorCode]

function signOut

退出登录

Parameters:

  • uid 退出用户的uid(默认输入0则退出当前登陆用户)

  • ignoreUnbindDevice 用户退出时是否忽略解绑定设备操作。对应某些服务器不可访问的情况下忽略服务器解绑定设备操作直接强制退出时设置为true

Return: [BMXErrorCode]

function signOut

function signOut

function connectStatus

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

Return: [BMXConnectStatus]

function signInStatus

获取当前的登录状态

Return: [BMXSignInStatus]

function reconnect

强制重新连接

function onNetworkChanged

处理网络状态发送变化

Parameters:

  • type 变化后的网络类型

  • reconnect 网络是否需要重连

Reimplements: im::floo::floolib::BMXNetworkListener::onNetworkChanged

function disconnect

断开网络连接

function changeAppId

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

Parameters:

  • appId 新变更的appId

  • appSecret 新变更的appSecret

function changeAppId

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

Parameters:

  • appId 新变更的appId

function initializeServerConfig

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

Parameters:

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

function sendMessage

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

Parameters:

  • msg 发送的消息

function create

创建BMXClient

Parameters:

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

Return: BMXClientPtr

Protected Functions Documentation

function BMXClient

function finalize

Reimplements: im::floo::floolib::BMXNetworkListener::finalize

function getCPtr


Updated on 2022-01-26 at 17:18:31 +0800

Last updated

Was this helpful?