floo::BMXMessageConfig#

Message configuration

#include <bmx_message_config.h>

Inherits from BMXBaseObject

Public Types#

Public Functions#

Friends#

Public Types Documentation#

enum BadgeCountType#

Operation applied to the current badge count

Public Functions Documentation#

function ~BMXMessageConfig#

inline virtual ~BMXMessageConfig()

Example:

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

function setMentionAll#

void setMentionAll(
    bool mentionAll
)

Set whether to @ all members

Parameters:

• mentionAll

Example:

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

function getMentionAll#

bool getMentionAll()

Get whether to @ all members

Return: bool

Example:

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

function setMentionList#

void setMentionList(
    const std::vector< int64_t > & mentionList
)

Set the list of notified member ids

Parameters:

• mentionList

Example:

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

function getMentionList#

std::vector< int64_t > getMentionList()

Get @ member list

Return: std::vector<int64_t>

Example:

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

function setMentionedMessage#

void setMentionedMessage(
    const std::string & mentionedMessage
)

Set @ message

Parameters:

• mentionedMessage

Example:

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

function getMentionedMessage#

std::string getMentionedMessage()

Get @ message

Return: std::string

Example:

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

function setPushMessage#

void setPushMessage(
    const std::string & pushMessage
)

Set push message

Parameters:

• pushMessage

Example:

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

function getPushMessage#

std::string getPushMessage()

Get push message

Return: std::string

Example:

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

function setSenderNickname#

void setSenderNickname(
    const std::string & senderNickname
)

Set nickname of sender

Parameters:

• senderNickname

Example:

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

function getSenderNickname#

std::string getSenderNickname()

Get nickname of sender

Return: std::string

Example:

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

function setGroupMemberList#

void setGroupMemberList(
    const std::vector< int64_t > & groupMemberList
)

Set the list of member ids that require read group messages

Parameters:

• groupMemberList

Example:

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

function getGroupMemberList#

std::vector< int64_t > getGroupMemberList()

Get the list of group member ids that require read group messages

Return: std::vector<int64_t>

Example:

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

function addGroupMember#

void addGroupMember(
    int64_t id
)

Member of group member id list with read messages added

Example:

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

function removeGroupMember#

void removeGroupMember(
    int64_t id
)

Empty the list of member ids that require read group messages

Return: std::vector<int64_t>

Example:

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

function clearGroupMemberList#

void clearGroupMemberList()

List of member ids with read group messages emptied

Example:

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

function setIOSConfig#

void setIOSConfig(
    const std::string & iosConfig
)

Set IOS system configuration information

Parameters:

• iosConfig

Example:

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

function getIOSConfig#

std::string getIOSConfig()

Get IOS system configuration information

Return: std::string

Example:

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

function setAndroidConfig#

void setAndroidConfig(
    const std::string & androidConfig
)

Set Android system configuration information

Parameters:

• androidConfig

Example:

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

function getAndroidConfig#

std::string getAndroidConfig()

Get Android system configuration information

Return: std::string

Example:

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

function setPushShowBeginTime#

void setPushShowBeginTime(
    int beginTime
)

Set start time for push display

Parameters:

• beginTime

Example:

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

function getPushShowBeginTime#

int getPushShowBeginTime()

Get start time for push display

Return: int

Example:

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

function setPushShowEndTime#

void setPushShowEndTime(
    int endTime
)

Set end time for push display

Parameters:

• endTime

Example:

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

function getPushShowEndTime#

int getPushShowEndTime()

Get end time for push display

Return: int

Example:

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

function setPushTitle#

void setPushTitle(
    const std::string & pushTitle
)

Set push header

Parameters:

• pushTitle

Example:

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

function getPushTitle#

std::string getPushTitle()

Get push header

Return: std::string

Example:

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

function isSilence#

bool isSilence()

Get whether the current push is a silent message

Return: bool

Example:

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

function getBadgeCountType#

BadgeCountType getBadgeCountType()

Get the badge count of the current push

Return: BadgeCountType

Example:

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

function getBadgeCount#

int getBadgeCount(
    int count
)

Get the badge count of the current push

Return: int

Example:

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

function setUsername#

void setUsername(
    const std::string & username
)

Set username

Parameters:

• username

Example:

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

function getUsername#

std::string getUsername()

Get username

Return: std::string

Example:

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

function serialize#

std::string serialize() const

Serialization operation

Return: std::string

Example:

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

function createMessageConfig#

static BMXMessageConfigPtr createMessageConfig(
    bool mentionAll
)

Friends#

friend encodeBMXMessageConfig#

friend std::string encodeBMXMessageConfig(
    BMXMessageConfigPtr 
);

friend decodeBMXMessageConfig#

friend BMXMessageConfigPtr decodeBMXMessageConfig(
    const std::string & config
);

Example:

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

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