im::floo::floolib::BMXUserService

用户Service

Public Functions

Name
synchronized void delete()
[BMXErrorCode] bindDevice(String token)
绑定设备推送token
[BMXErrorCode] getDeviceList(BMXDeviceList deviceList)
获取设备列表
[BMXErrorCode] getProfile(BMXUserProfile profile, boolean forceRefresh)
获取用户详情,如果forceRefresh == true,则强制从服务端拉取
[BMXErrorCode] deleteDevice(int device_sn)
删除设备
[BMXErrorCode] setNickname(String nickname)
设置昵称
[BMXErrorCode] uploadAvatar(String avatarPath, FileProgressListener callback)
上传头像
[BMXErrorCode] downloadAvatar(BMXUserProfile profile, boolean thumbnail, FileProgressListener callback)
下载头像,默认下载缩略图
[BMXErrorCode] setPublicInfo(String publicInfo)
设置公开扩展信息
[BMXErrorCode] setPrivateInfo(String privateInfo)
设置私有扩展信息
[BMXErrorCode] setAddFriendAuthMode(BMXUserProfile.AddFriendAuthMode mode)
设置加好友验证方式
[BMXErrorCode] setAuthQuestion(BMXUserProfile.AuthQuestion authQuestion)
设置加好友验证问题
[BMXErrorCode] setEnablePush(boolean enable)
设置是否允许推送
[BMXErrorCode] setEnablePushDetaile(boolean enable)
设置是否推送详情
[BMXErrorCode] setPushNickname(String nickname)
设置推送昵称
[BMXErrorCode] setPushAlias(String alias, String bmxPushToken)
设置推送别名
[BMXErrorCode] setNotificationSound(boolean enable)
设置收到新消息是否声音提醒
[BMXErrorCode] setNotificationVibrate(boolean enable)
设置收到新消息是否震动
[BMXErrorCode] setAutoDownloadAttachment(boolean enable)
设置是否自动缩略图和语音附件
[BMXErrorCode] setAutoAcceptGroupInvite(boolean enable)
设置是否自动同意入群邀请
void addUserListener(BMXUserServiceListener listener)
添加用户状态监听者
void removeUserListener(BMXUserServiceListener listener)
移除用户状态监听者

Protected Functions

Name
BMXUserService(long cPtr, boolean cMemoryOwn)
void finalize()
long getCPtr(BMXUserService obj)

Protected Attributes

Name
transient boolean swigCMemOwn

Public Functions Documentation

function delete

inline synchronized void delete()

Example:

function bindDevice

inline BMXErrorCode bindDevice(
    String token
)

绑定设备推送token

Parameters:

  • token 设备token

Return: [BMXErrorCode]

Example:

function getDeviceList

inline BMXErrorCode getDeviceList(
    BMXDeviceList deviceList
)

获取设备列表

Parameters:

  • deviceList 设备列表,传入空列表函数返回后从此处获取返回的设备列表

Return: [BMXErrorCode]

Example:

function getProfile

inline BMXErrorCode getProfile(
    BMXUserProfile profile,
    boolean forceRefresh
)

获取用户详情,如果forceRefresh == true,则强制从服务端拉取

Parameters:

  • profile 用户profile信息,初始传入指向为空的shared_ptr对象,函数返回后从此处获取用户profile信息。
  • forceRefresh 是否强制从服务器拉取,本地获取失败的情况下会自动从服务器拉取

Return: [BMXErrorCode]

Example:

public BMXUserProfile getProfileByDB() {
    BMXUserProfile profile = new BMXUserProfile();
    BMXErrorCode error = mUserService.getProfile(profile, false);
    if (error == null || error.swigValue() != BMXErrorCode.NoError.swigValue()) {
        return null;
    }
    return profile;

function deleteDevice

inline BMXErrorCode deleteDevice(
    int device_sn
)

删除设备

Parameters:

  • device_sn 设备序列号

Return: [BMXErrorCode]

Example:

function setNickname

inline BMXErrorCode setNickname(
    String nickname
)

设置昵称

Parameters:

  • nickname 用户昵称

Return: [BMXErrorCode]

Example:

function uploadAvatar

inline BMXErrorCode uploadAvatar(
    String avatarPath,
    FileProgressListener callback
)

上传头像

Parameters:

  • avatarPath 上传头像的本地地址
  • callback 上传回调函数

Return: [BMXErrorCode]

Example:

function downloadAvatar

inline BMXErrorCode downloadAvatar(
    BMXUserProfile profile,
    boolean thumbnail,
    FileProgressListener callback
)

下载头像,默认下载缩略图

Parameters:

  • profile 用户profile
  • thumbnail 是否下载缩略图,true下载缩略图,false下载原图
  • callback 下载回调函数

Return: [BMXErrorCode]

Example:

function setPublicInfo

inline BMXErrorCode setPublicInfo(
    String publicInfo
)

设置公开扩展信息

Parameters:

  • publicInfo 公开扩展信息

Return: [BMXErrorCode]

Example:

function setPrivateInfo

inline BMXErrorCode setPrivateInfo(
    String privateInfo
)

设置私有扩展信息

Parameters:

  • privateInfo 私有扩展信息

Return: [BMXErrorCode]

Example:

function setAddFriendAuthMode

inline BMXErrorCode setAddFriendAuthMode(
    BMXUserProfile.AddFriendAuthMode mode
)

设置加好友验证方式

Parameters:

  • mode 加好友验证方式

Return: [BMXErrorCode]

Example:

function setAuthQuestion

inline BMXErrorCode setAuthQuestion(
    BMXUserProfile.AuthQuestion authQuestion
)

设置加好友验证问题

Parameters:

  • authQuestion 加好友验证问题

Return: [BMXErrorCode]

Example:

function setEnablePush

inline BMXErrorCode setEnablePush(
    boolean enable
)

设置是否允许推送

Parameters:

  • enable 是否允许推送,true推送,false不推送

Return: [BMXErrorCode]

Example:

function setEnablePushDetaile

inline BMXErrorCode setEnablePushDetaile(
    boolean enable
)

设置是否推送详情

Parameters:

  • enable 是否推送详情,true推送,false不推送

Return: [BMXErrorCode]

Example:

function setPushNickname

inline BMXErrorCode setPushNickname(
    String nickname
)

设置推送昵称

Parameters:

  • nickname 推送昵称

Return: [BMXErrorCode]

Example:

function setPushAlias

inline BMXErrorCode setPushAlias(
    String alias,
    String bmxPushToken
)

设置推送别名

Parameters:

  • alias 别名
  • bmxPushToken 推送token

Return: [BMXErrorCode]

Example:

function setNotificationSound

inline BMXErrorCode setNotificationSound(
    boolean enable
)

设置收到新消息是否声音提醒

Parameters:

  • enable 收到新消息是否声音提醒,true提醒,false不提醒

Return: [BMXErrorCode]

Example:

function setNotificationVibrate

inline BMXErrorCode setNotificationVibrate(
    boolean enable
)

设置收到新消息是否震动

Parameters:

  • enable 收到新消息是否震动,true震动,false不震动

Return: [BMXErrorCode]

Example:

function setAutoDownloadAttachment

inline BMXErrorCode setAutoDownloadAttachment(
    boolean enable
)

设置是否自动缩略图和语音附件

Parameters:

  • enable 是否自动缩略图和语音附件,true自动下载,false不会自动下载

Return: [BMXErrorCode]

Example:

function setAutoAcceptGroupInvite

inline BMXErrorCode setAutoAcceptGroupInvite(
    boolean enable
)

设置是否自动同意入群邀请

Parameters:

  • enable 是否自动同意入群邀请,true同意,false不同意

Return: [BMXErrorCode]

Example:

function addUserListener

inline void addUserListener(
    BMXUserServiceListener listener
)

添加用户状态监听者

Parameters:

  • listener 用户状态监听者

Example:

function removeUserListener

inline void removeUserListener(
    BMXUserServiceListener listener
)

移除用户状态监听者

Parameters:

  • listener 用户状态监听者

Protected Functions Documentation

Example:

function BMXUserService

inline BMXUserService(
    long cPtr,
    boolean cMemoryOwn
)

Example:

function finalize

inline void finalize()

Example:

function getCPtr

static inline long getCPtr(
    BMXUserService obj
)

Protected Attributes Documentation

variable swigCMemOwn

transient boolean swigCMemOwn;

Example:


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

© 2019-2022 美信拓扑 | 官网 该文件修订时间: 2022-09-21 11:43:07

results matching ""

    No results matching ""