floo::BMXUserService#

User Service

#include <bmx_user_service.h>

Public Types#

Public Functions#

Protected Functions#

Public Types Documentation#

typedef Callback#

typedef std::function<void(int percent)> floo::BMXUserService::Callback;

Public Functions Documentation#

function ~BMXUserService#

inline virtual ~BMXUserService()

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="~BMXUserService" %}{% endlanying_code_snippet %}

function bindDevice#

virtual BMXErrorCode bindDevice(
    const std::string & token
) =0

Binding device push token

Parameters:

• token Device token

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="bindDevice" %}{% endlanying_code_snippet %}

function getDeviceList#

virtual BMXErrorCode getDeviceList(
    BMXDeviceList & deviceList
) =0

Get device list

Parameters:

• deviceList Device list, pass in an empty list function and fetch the returned device list here

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="getDeviceList" %}{% endlanying_code_snippet %}

function deleteDevice#

virtual BMXErrorCode deleteDevice(
    int32_t device_sn
) =0

Delete device

Parameters:

• device_sn Device serial number

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="deleteDevice" %}{% endlanying_code_snippet %}

function getProfile#

virtual BMXErrorCode getProfile(
    BMXUserProfilePtr & profile,
    bool forceRefresh
) =0

Get user details, force pull from server if forceRefresh == true

Parameters:

• profile User profile, initially passed in a pointing-to-empty shared_ptr object, and fetch user profile here after the function returned.
• forceRefresh Whether to force pull from server, automatically if local fetch failed

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="getProfile" %}{% endlanying_code_snippet %}

function setNickname#

virtual BMXErrorCode setNickname(
    const std::string & nickname
) =0

Set nickname

Parameters:

• nickname User nickname

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setNickname" %}{% endlanying_code_snippet %}

function uploadAvatar#

virtual BMXErrorCode uploadAvatar(
    const std::string & avatarPath,
    Callback callback
) =0

Upload avatar

Parameters:

• avatarPath Local address to upload avatar
• callback Upload callback function

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="uploadAvatar" %}{% endlanying_code_snippet %}

function downloadAvatar#

virtual BMXErrorCode downloadAvatar(
    BMXUserProfilePtr profile,
    bool thumbnail,
    Callback callback
) =0

Download avatar, default to download thumbnail

Parameters:

• profile User profile
• thumbnail Whether to download thumbnail, true for thumbnail, false for original
• callback Download callback function

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="downloadAvatar" %}{% endlanying_code_snippet %}

function setPublicInfo#

virtual BMXErrorCode setPublicInfo(
    const std::string & publicInfo
) =0

Set public extension information

Parameters:

• publicInfo Public extension information

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setPublicInfo" %}{% endlanying_code_snippet %}

function setPrivateInfo#

virtual BMXErrorCode setPrivateInfo(
    const std::string & privateInfo
) =0

Set private extension information

Parameters:

• privateInfo Private extension information

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setPrivateInfo" %}{% endlanying_code_snippet %}

function setAddFriendAuthMode#

virtual BMXErrorCode setAddFriendAuthMode(
    BMXUserProfile::AddFriendAuthMode mode
) =0

Set method to validate when adding friend

Parameters:

• mode Add friend authentication

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setAddFriendAuthMode" %}{% endlanying_code_snippet %}

function setAuthQuestion#

virtual BMXErrorCode setAuthQuestion(
    const BMXUserProfile::AuthQuestion & authQuestion
) =0

Set friend authentication questions

Parameters:

• authQuestion Add friend authentication question

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setAuthQuestion" %}{% endlanying_code_snippet %}

function setEnablePush#

virtual BMXErrorCode setEnablePush(
    bool enable
) =0

Set whether push is allowed

Parameters:

• enable Whether to allow push, true to push, false not to

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setEnablePush" %}{% endlanying_code_snippet %}

function setEnablePushDetaile#

virtual BMXErrorCode setEnablePushDetaile(
    bool enable
) =0

Set whether to push details

Parameters:

• enable Whether to push details, true to push, false not to

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setEnablePushDetaile" %}{% endlanying_code_snippet %}

function setPushNickname#

virtual BMXErrorCode setPushNickname(
    const std::string & nickname
) =0

Set push nickname

Parameters:

• nickname Push nickname

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setPushNickname" %}{% endlanying_code_snippet %}

function setPushAlias#

virtual BMXErrorCode setPushAlias(
    const std::string & alias,
    const std::string & bmxPushToken
) =0

Parameters:

• nickname Push nickname

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setPushAlias" %}{% endlanying_code_snippet %}

function setNotificationSound#

virtual BMXErrorCode setNotificationSound(
    bool enable
) =0

Set whether a new message is audibly alerted

Parameters:

• enable Whether to sound alert when new message received, true to alert, false not to

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setNotificationSound" %}{% endlanying_code_snippet %}

function setNotificationVibrate#

virtual BMXErrorCode setNotificationVibrate(
    bool enable
) =0

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

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setNotificationVibrate" %}{% endlanying_code_snippet %}

function setAutoDownloadAttachment#

virtual BMXErrorCode setAutoDownloadAttachment(
    bool enable
) =0

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

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setAutoDownloadAttachment" %}{% endlanying_code_snippet %}

function setAutoAcceptGroupInvite#

virtual BMXErrorCode setAutoAcceptGroupInvite(
    bool enable
) =0

Set whether to automatically accept group invitations

Parameters:

• enable Whether to automatically agree to group invitation, true to agree, false not to

Return: BMXErrorCode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="setAutoAcceptGroupInvite" %}{% endlanying_code_snippet %}

function addUserListener#

virtual void addUserListener(
    BMXUserServiceListener * listener
) =0

Add user state listener

Parameters:

• listener User state listener

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="addUserListener" %}{% endlanying_code_snippet %}

function removeUserListener#

virtual void removeUserListener(
    BMXUserServiceListener * listener
) =0

Remove user state listener

Parameters:

• listener User state listener

Protected Functions Documentation#

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="removeUserListener" %}{% endlanying_code_snippet %}

function BMXUserService#

inline BMXUserService()

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserService",function="BMXUserService" %}{% endlanying_code_snippet %}

Updated on 2022-01-26 at 17:20:40 +0800