floo::BMXMessageConfig

消息配置

#include <bmx_message_config.h>

Inherits from BMXBaseObject

Public Types

Public Functions

Friends

Public Types Documentation

enum BadgeCountType

当前读取的Badge数字的操作类型

Public Functions Documentation

function ~BMXMessageConfig

inline virtual ~BMXMessageConfig()

Example:

function setMentionAll

void setMentionAll(
    bool mentionAll
)

设置是否@全员

Parameters:

• mentionAll

Example:

function getMentionAll

bool getMentionAll()

获取是否@全员

Return: bool

Example:

function setMentionList

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

设置通知成员id列表

Parameters:

• mentionList

Example:

function getMentionList

std::vector< int64_t > getMentionList()

获取@成员列表

Return: std::vector

Example:

function setMentionedMessage

void setMentionedMessage(
    const std::string & mentionedMessage
)

设置@消息

Parameters:

• mentionedMessage

Example:

function getMentionedMessage

std::string getMentionedMessage()

获取@消息

Return: std::string

Example:

function setPushMessage

void setPushMessage(
    const std::string & pushMessage
)

设置推送消息

Parameters:

• pushMessage

Example:

function getPushMessage

std::string getPushMessage()

获取推送消息

Return: std::string

Example:

function setSenderNickname

void setSenderNickname(
    const std::string & senderNickname
)

设置发送者昵称

Parameters:

• senderNickname

Example:

function getSenderNickname

std::string getSenderNickname()

获取发送者昵称

Return: std::string

Example:

function setGroupMemberList

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

设置需要群已读消息的群成员id列表

Parameters:

• groupMemberList

Example:

function getGroupMemberList

std::vector< int64_t > getGroupMemberList()

获取需要群已读消息的群成员id列表

Return: std::vector

Example:

function addGroupMember

void addGroupMember(
    int64_t id
)

添加群已读消息的群成员id列表成员

Example:

function removeGroupMember

void removeGroupMember(
    int64_t id
)

清除需要群已读消息的群成员id列表成员

Return: std::vector

Example:

function clearGroupMemberList

void clearGroupMemberList()

清空群已读消息的群成员id列表

Example:

function setIOSConfig

void setIOSConfig(
    const std::string & iosConfig
)

设置IOS系统配置信息

Parameters:

• iosConfig

Example:

function getIOSConfig

std::string getIOSConfig()

获取IOS系统配置信息

Return: std::string

Example:

function setAndroidConfig

void setAndroidConfig(
    const std::string & androidConfig
)

设置Android系统配置信息

Parameters:

• androidConfig

Example:

function getAndroidConfig

std::string getAndroidConfig()

获取Android系统配置信息

Return: std::string

Example:

function setPushShowBeginTime

void setPushShowBeginTime(
    int beginTime
)

设置推送显示开始时间

Parameters:

• beginTime

Example:

function getPushShowBeginTime

int getPushShowBeginTime()

获取推送显示开始时间

Return: int

Example:

function setPushShowEndTime

void setPushShowEndTime(
    int endTime
)

设置推送显示结束时间

Parameters:

• endTime

Example:

function getPushShowEndTime

int getPushShowEndTime()

获取推送显示结束时间

Return: int

Example:

function setPushTitle

void setPushTitle(
    const std::string & pushTitle
)

设置推送标题

Parameters:

• pushTitle

Example:

function getPushTitle

std::string getPushTitle()

获取推送标题

Return: std::string

Example:

function isSilence

bool isSilence()

获取当前的推送消息是否是静默消息

Return: bool

Example:

function getBadgeCountType

BadgeCountType getBadgeCountType()

获取当前的推送消息中badge计数

Return: BadgeCountType

Example:

function getBadgeCount

int getBadgeCount(
    int count
)

获取当前的推送消息中badge计数

Return: int

Example:

function setUsername

void setUsername(
    const std::string & username
)

设置用户名

Parameters:

• username

Example:

function getUsername

std::string getUsername()

获得用户名

Return: std::string

Example:

function serialize

std::string serialize() const

序列化操作

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