im::floo::floolib::BMXUserManager

User manager

Public Functions

Public Functions Documentation

function BMXUserManager

inline BMXUserManager(
    BMXUserService service,
    BMXClient bmxClient
)

Example:

function signUpNewUser

inline void signUpNewUser(
    final String username,
    final String password,
    final BMXDataCallBack< BMXUserProfile > callBack
)

Register

Parameters:

• password Password
• username Username
• callBack BMXUserProfile

Example:

public void signUpNewUser(String username, String password, BMXDataCallBack<BMXUserProfile> callBack) {
    mService.signUpNewUser(username, password, callBack);

function signInByName

inline void signInByName(
    final String name,
    final String password,
    final BMXCallBack callBack
)

Username login

Parameters:

• name
• password
• callBack [BMXErrorCode]

Example:

public void signInByName(String name, String password, BMXCallBack callBack) {
    mService.signInByName(name, password, callBack);

function signInById

inline void signInById(
    final long id,
    final String password,
    final BMXCallBack callBack
)

id login

Parameters:

• id
• password
• callBack [BMXErrorCode]

Example:

public void signInById(long id, String password, BMXCallBack callBack) {
    mService.signInById(id, password, callBack);

function autoSignInByName

inline void autoSignInByName(
    final String name,
    final String password,
    final BMXCallBack callBack
)

Auto login, by username

Parameters:

• name
• password
• callBack [BMXErrorCode]

Example:

public void autoSignInByName(String name, String password, BMXCallBack callBack) {
    mService.autoSignInByName(name, password, callBack);

function autoSignInById

inline void autoSignInById(
    final long uid,
    final String password,
    final BMXCallBack callBack
)

Auto login, by id

Parameters:

• uid
• password
• callBack [BMXErrorCode]

Example:

public void autoSignInById(long uid, String password, BMXCallBack callBack) {
    mService.autoSignInById(uid, password, callBack);

function signOut

inline void signOut(
    final BMXCallBack callBack
)

Log out

Parameters:

• callBack [BMXErrorCode]

Example:

public void signOut(BMXCallBack callBack) {
    mService.signOut(callBack);

public void signOut(long userId, BMXCallBack callBack) {
    mService.signOut(userId, callBack);

function signOut

inline void signOut(
    final long userId,
    final BMXCallBack callBack
)

Log out

Parameters:

• callBack [BMXErrorCode]

Example:

public void signOut(BMXCallBack callBack) {
    mService.signOut(callBack);

public void signOut(long userId, BMXCallBack callBack) {
    mService.signOut(userId, callBack);

function connectStatus

inline BMXConnectStatus connectStatus()

Get the current connection state with server

Example:

public BMXConnectStatus connectStatus() {
    return mService.connectStatus();

function signInStatus

inline BMXSignInStatus signInStatus()

Get the current login state

Example:

public BMXSignInStatus signInStatus() {
    return mService.signInStatus();

function bindDevice

inline void bindDevice(
    final String token,
    final BMXCallBack callBack
)

Binding device push token

Parameters:

• token device token
• callBack [BMXErrorCode]

Example:

public void bindDevice(String token, BMXCallBack callBack) {
    mService.bindDevice(token, callBack);

function getDeviceList

inline void getDeviceList(
    final BMXDataCallBack< BMXDeviceList > callBack
)

Get list of logged-in devices

Parameters:

• callBack [BMXErrorCode] list of logged-in devices

Example:

public void getDeviceList(BMXDataCallBack<BMXDeviceList> callBack) {
    mService.getDeviceList(callBack);

function deleteDevice

inline void deleteDevice(
    final int device_sn,
    final BMXCallBack callBack
)

Delete device

Parameters:

• callBack [BMXErrorCode]

Example:

public void deleteDevice(int device_sn, BMXCallBack callBack) {
    mService.deleteDevice(device_sn, callBack);

function getProfile

inline void getProfile(
    final boolean forceRefresh,
    final BMXDataCallBack< BMXUserProfile > callBack
)

Get user details

Parameters:

• forceRefresh Force pull latest results from server
• callBack [BMXErrorCode], user details

Example:

public void getProfile(boolean forceRefresh, BMXDataCallBack<BMXUserProfile> callBack) {
    mService.getProfile(forceRefresh, callBack);

function setNickname

inline void setNickname(
    final String nickname,
    final BMXCallBack callBack
)

Set nickname

Parameters:

• nickname Nickname
• callBack [BMXErrorCode]

Example:

public void setNickname(String nickname, BMXCallBack callBack) {
    mService.setNickname(nickname, callBack);

function uploadAvatar

inline void uploadAvatar(
    final String avatarPath,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Upload avatar

Parameters:

• avatarPath Local file path of avatar
• listener Uploading progress listener
• callBack [BMXErrorCode]

Example:

public void uploadAvatar(String avatarPath, FileProgressListener listener, BMXCallBack callBack) {
    mService.uploadAvatar(avatarPath, listener, callBack);

function downloadAvatar

inline void downloadAvatar(
    final BMXUserProfile profile,
    final FileProgressListener listener,
    final BMXCallBack callBack
)

Download avatar

Parameters:

• profile User details
• listener Downloading progress listener
• callBack [BMXErrorCode]

Example:

public void downloadAvatar(BMXUserProfile profile, FileProgressListener listener, BMXCallBack callBack) {
    mService.downloadAvatar(profile, listener, callBack);

function setPublicInfo

inline void setPublicInfo(
    final String publicInfo,
    final BMXCallBack callBack
)

Set public extension information

Parameters:

• publicInfo User public information
• callBack [BMXErrorCode]

Example:

public void setPublicInfo(String publicInfo, BMXCallBack callBack) {
    mService.setPublicInfo(publicInfo, callBack);

function setPrivateInfo

inline void setPrivateInfo(
    final String privateInfo,
    final BMXCallBack callBack
)

Set private extension information

Parameters:

• privateInfo User private information (self-visibe only)
• callBack [BMXErrorCode]

Example:

public void setPrivateInfo(String privateInfo, BMXCallBack callBack) {
    mService.setPrivateInfo(privateInfo, callBack);

function setAddFriendAuthMode

inline void setAddFriendAuthMode(
    final BMXUserProfile.AddFriendAuthMode mode,
    final BMXCallBack callBack
)

Set method to validate when adding friend

Parameters:

• mode How to validate when adding friend
• callBack [BMXErrorCode]

Example:

public void setAddFriendAuthMode(BMXUserProfile.AddFriendAuthMode mode, BMXCallBack callBack) {
    mService.setAddFriendAuthMode(mode, callBack);

function setAuthQuestion

inline void setAuthQuestion(
    final BMXUserProfile.AuthQuestion authQuestion,
    final BMXCallBack callBack
)

Set friend authentication questions

Parameters:

• authQuestion Verification question
• callBack [BMXErrorCode]

Example:

public void setAuthQuestion(BMXUserProfile.AuthQuestion authQuestion, BMXCallBack callBack) {
    mService.setAuthQuestion(authQuestion, callBack);

function setEnablePush

inline void setEnablePush(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether push is allowed

Parameters:

• enable Whether to allow push, true to push, false not to
• callBack [BMXErrorCode]

Example:

public void setEnablePush(boolean enable, BMXCallBack callBack) {
    mService.setEnablePush(enable, callBack);

function setEnablePushDetaile

inline void setEnablePushDetaile(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether to push details

Parameters:

• enable Whether to push details, true to push, false not to
• callBack [BMXErrorCode]

Example:

public void setEnablePushDetaile(boolean enable, BMXCallBack callBack) {
    mService.setEnablePushDetaile(enable, callBack);

function setPushNickname

inline void setPushNickname(
    final String nickname,
    final BMXCallBack callBack
)

Set push nickname

Parameters:

• nickname Push nickname
• callBack [BMXErrorCode]

Example:

public void setPushNickname(String nickname, BMXCallBack callBack) {
    mService.setPushNickname(nickname, callBack);

function setPushAlias

inline void setPushAlias(
    final String alias,
    final String bmxPushToken,
    final BMXCallBack callBack
)

Set push alias

Parameters:

• alias Alias
• bmxPushToken Push token
• callBack [BMXErrorCode]

Example:

function setNotificationSound

inline void setNotificationSound(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether a new message is audibly alerted

Parameters:

• enable Whether to sound alert when new message received, true to alert, false not to
• callBack [BMXErrorCode]

Example:

public void setNotificationSound(boolean enable, BMXCallBack callBack) {
    mService.setNotificationSound(enable, callBack);

function setNotificationVibrate

inline void setNotificationVibrate(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether a new message is alerted in vibration

Parameters:

• enable Whether to vibrate alert when new message received, true to alert, false not to
• callBack [BMXErrorCode]

Example:

public void setNotificationVibrate(boolean enable, BMXCallBack callBack) {
    mService.setNotificationVibrate(enable, callBack);

function setAutoDownloadAttachment

inline void setAutoDownloadAttachment(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether to automatically download thumbnail and voice attachment

Parameters:

• enable Whether to automatically download thumbnail and voice attachment, true to download, false not to
• callBack [BMXErrorCode]

Example:

public void setAutoDownloadAttachment(boolean enable, BMXCallBack callBack) {
    mService.setAutoDownloadAttachment(enable, callBack);

function setAutoAcceptGroupInvite

inline void setAutoAcceptGroupInvite(
    final boolean enable,
    final BMXCallBack callBack
)

Set whether to automatically accept group invitations

Parameters:

• enable Whether to automatically agree to group invitation, true to agree, false not to
• callBack [BMXErrorCode]

Example:

public void setAutoAcceptGroupInvite(boolean enable, BMXCallBack callBack) {
    mService.setAutoAcceptGroupInvite(enable, callBack);

function addUserListener

inline void addUserListener(
    BMXUserServiceListener listener
)

Add user state listener

Parameters:

• listener User state listener

Example:

public void addUserListener(BMXUserServiceListener listener) {
    mService.addUserListener(listener);

function removeUserListener

inline void removeUserListener(
    BMXUserServiceListener listener
)

Remove user state listener

Parameters:

• listener User state listener

Example:

public void removeUserListener(BMXUserServiceListener listener) {
    mService.removeUserListener(listener);

function changeAppId

inline void changeAppId(
    final String appId,
    final BMXCallBack callBack
)

Switch appId

Parameters:

• appId appId

Example:

public void changeAppId(String appId, BMXCallBack callBack) {
    mService.changeAppId(appId, callBack);

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