floo::BMXMessageConfig

Message configuration

#include <bmx_message_config.h>

Inherits from BMXBaseObject

Public Types

Public Functions

Friends

Public Types Documentation

enum BadgeCountType

Operation type of the currently read Badge number

Public Functions Documentation

function ~BMXMessageConfig

inline virtual ~BMXMessageConfig()

Example:

function setMentionAll

void setMentionAll(
    bool mentionAll
)

Set whether to @ all members

Parameters:

• mentionAll

Example:

function getMentionAll

bool getMentionAll()

Get whether to @ all members

Return: bool

Example:

function setMentionList

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

Set the list of notified member ids

Parameters:

• mentionList

Example:

function getMentionList

std::vector< int64_t > getMentionList()

Get @ member list

Return: std::vector

Example:

function setMentionedMessage

void setMentionedMessage(
    const std::string & mentionedMessage
)

Set @ message

Parameters:

• mentionedMessage

Example:

function getMentionedMessage

std::string getMentionedMessage()

Get @ message

Return: std::string

Example:

function setPushMessage

void setPushMessage(
    const std::string & pushMessage
)

Set push message

Parameters:

• pushMessage

Example:

function getPushMessage

std::string getPushMessage()

Get push message

Return: std::string

Example:

function setSenderNickname

void setSenderNickname(
    const std::string & senderNickname
)

Set nickname of sender

Parameters:

• senderNickname

Example:

function getSenderNickname

std::string getSenderNickname()

Get nickname of sender

Return: std::string

Example:

function setGroupMemberList

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

Set the list of member ids that require read group messages

Parameters:

• groupMemberList

Example:

function getGroupMemberList

std::vector< int64_t > getGroupMemberList()

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

Return: std::vector

Example:

function addGroupMember

void addGroupMember(
    int64_t id
)

Member of group member id list with read messages added

Example:

function removeGroupMember

void removeGroupMember(
    int64_t id
)

Empty the list of member ids that require read group messages

Return: std::vector

Example:

function clearGroupMemberList

void clearGroupMemberList()

List of member ids with read group messages emptied

Example:

function setIOSConfig

void setIOSConfig(
    const std::string & iosConfig
)

Set IOS system configuration information

Parameters:

• iosConfig

Example:

function getIOSConfig

std::string getIOSConfig()

Get IOS system configuration information

Return: std::string

Example:

function setAndroidConfig

void setAndroidConfig(
    const std::string & androidConfig
)

Set Android system configuration information

Parameters:

• androidConfig

Example:

function getAndroidConfig

std::string getAndroidConfig()

Get Android system configuration information

Return: std::string

Example:

function setPushShowBeginTime

void setPushShowBeginTime(
    int beginTime
)

Set start time for push display

Parameters:

• beginTime

Example:

function getPushShowBeginTime

int getPushShowBeginTime()

Get start time for push display

Return: int

Example:

function setPushShowEndTime

void setPushShowEndTime(
    int endTime
)

Set end time for push display

Parameters:

• endTime

Example:

function getPushShowEndTime

int getPushShowEndTime()

Get end time for push display

Return: int

Example:

function setPushTitle

void setPushTitle(
    const std::string & pushTitle
)

Set push header

Parameters:

• pushTitle

Example:

function getPushTitle

std::string getPushTitle()

Get push header

Return: std::string

Example:

function isSilence

bool isSilence()

Get whether the current push is a silent message

Return: bool

Example:

function getBadgeCountType

BadgeCountType getBadgeCountType()

Get the badge count of the current push

Return: BadgeCountType

Example:

function getBadgeCount

int getBadgeCount(
    int count
)

Get the badge count of the current push

Return: int

Example:

function setUsername

void setUsername(
    const std::string & username
)

Set username

Parameters:

• username

Example:

function getUsername

std::string getUsername()

Get username

Return: std::string

Example:

function serialize

std::string serialize() const

Serialization operation

Return: std::string

Example:

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:

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