floo::BMXUserService#

使用者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

綁定設備推播token

Parameters:

• token 設備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

取得設備列表

Parameters:

• deviceList 設備列表，傳入空列表函數回傳後從此處取得回傳的設備列表

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

刪除設備

Parameters:

• device_sn 設備序列號

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

取得使用者詳情，如果forceRefresh == true，則強制從服務端拉取

Parameters:

• profile 使用者profile信息，初始傳入指向為空的shared_ptr物件，函數回傳後從此處取得使用者profile信息。
• forceRefresh 是否強制從伺服器拉取，本地取得失敗的情況下會自動從伺服器拉取

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

設定暱稱

Parameters:

• 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

上傳頭像

Parameters:

• avatarPath 上傳頭像的本地地址
• callback 上傳回呼函數

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

下載頭像，預設下載縮略圖

Parameters:

• profile 使用者profile
• thumbnail 是否下載縮略圖，true下載縮略圖，false下載原圖
• callback 下載回呼函數

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

設定公開擴展信息

Parameters:

• publicInfo 公開擴展信息

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

設定私有擴展信息

Parameters:

• privateInfo 私有擴展信息

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

設定加好友驗證方式

Parameters:

• mode 加好友驗證方式

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

設定加好友驗證問題

Parameters:

• authQuestion 加好友驗證問題

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

設定是否允許推播

Parameters:

• enable 是否允許推播，true推播，false不推播

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

設定是否推播詳情

Parameters:

• enable 是否推播詳情，true推播，false不推播

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

設定推播暱稱

Parameters:

• 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 推播暱稱

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

設定收到新訊息是否聲音提醒

Parameters:

• enable 收到新訊息是否聲音提醒，true提醒，false不提醒

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

設定收到新訊息是否震動

Parameters:

• enable 收到新訊息是否震動，true震動，false不震動

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

設定是否自動縮略圖和語音附件

Parameters:

• enable 是否自動縮略圖和語音附件，true自動下載，false不會自動下載

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

設定是否自動同意入群邀請

Parameters:

• enable 是否自動同意入群邀請，true同意，false不同意

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

添加使用者狀態監聽者

Parameters:

• listener 使用者狀態監聽者

Example:

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

function removeUserListener#

virtual void removeUserListener(
    BMXUserServiceListener * listener
) =0

移除使用者狀態監聽者

Parameters:

• 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