floo::BMXMessageConfig

消息配置

#include <bmx_message_config.h>

Inherits from BMXBaseObject

Public Types

	Name
enum class	BadgeCountType { Change, Set} 当前读取的Badge数字的操作类型

Public Functions

	Name
virtual	~BMXMessageConfig()
void	setMentionAll(bool mentionAll) 设置是否@全员
bool	getMentionAll() 获取是否@全员
void	setMentionList(const std::vector< int64_t > & mentionList) 设置通知成员id列表
std::vector< int64_t >	getMentionList() 获取@成员列表
void	setMentionedMessage(const std::string & mentionedMessage) 设置@消息
std::string	getMentionedMessage() 获取@消息
void	setPushMessage(const std::string & pushMessage) 设置推送消息
std::string	getPushMessage() 获取推送消息
void	setSenderNickname(const std::string & senderNickname) 设置发送者昵称
std::string	getSenderNickname() 获取发送者昵称
void	setGroupMemberList(const std::vector< int64_t > & groupMemberList) 设置需要群已读消息的群成员id列表
std::vector< int64_t >	getGroupMemberList() 获取需要群已读消息的群成员id列表
void	addGroupMember(int64_t id) 添加群已读消息的群成员id列表成员
void	removeGroupMember(int64_t id) 清除需要群已读消息的群成员id列表成员
void	clearGroupMemberList() 清空群已读消息的群成员id列表
void	setIOSConfig(const std::string & iosConfig) 设置IOS系统配置信息
std::string	getIOSConfig() 获取IOS系统配置信息
void	setAndroidConfig(const std::string & androidConfig) 设置Android系统配置信息
std::string	getAndroidConfig() 获取Android系统配置信息
void	setPushShowBeginTime(int beginTime) 设置推送显示开始时间
int	getPushShowBeginTime() 获取推送显示开始时间
void	setPushShowEndTime(int endTime) 设置推送显示结束时间
int	getPushShowEndTime() 获取推送显示结束时间
void	setPushTitle(const std::string & pushTitle) 设置推送标题
std::string	getPushTitle() 获取推送标题
bool	isSilence() 获取当前的推送消息是否是静默消息
BadgeCountType	getBadgeCountType() 获取当前的推送消息中badge计数
int	getBadgeCount(int count) 获取当前的推送消息中badge计数
void	setUsername(const std::string & username) 设置用户名
std::string	getUsername() 获得用户名
std::string	serialize() const 序列化操作
BMXMessageConfigPtr	createMessageConfig(bool mentionAll)

Friends

	Name
std::string	encodeBMXMessageConfig(BMXMessageConfigPtr )
BMXMessageConfigPtr	decodeBMXMessageConfig(const std::string & config)

Public Types Documentation

enum BadgeCountType

Enumerator	Value	Description
Change		读取Badge计数的操作类型为增加或减少。正数为增加负数为减少
Set		设置Badge的计数为当前的计数值

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

Public Functions Documentation

function ~BMXMessageConfig

inline virtual ~BMXMessageConfig()

function setMentionAll

void setMentionAll(
    bool mentionAll
)

设置是否@全员

Parameters:

• mentionAll

function getMentionAll

bool getMentionAll()

获取是否@全员

Return: bool

function setMentionList

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

设置通知成员id列表

Parameters:

• mentionList

function getMentionList

std::vector< int64_t > getMentionList()

获取@成员列表

Return: std::vector<int64_t>

function setMentionedMessage

void setMentionedMessage(
    const std::string & mentionedMessage
)

设置@消息

Parameters:

• mentionedMessage

function getMentionedMessage

std::string getMentionedMessage()

获取@消息

Return: std::string

function setPushMessage

void setPushMessage(
    const std::string & pushMessage
)

设置推送消息

Parameters:

• pushMessage

function getPushMessage

std::string getPushMessage()

获取推送消息

Return: std::string

function setSenderNickname

void setSenderNickname(
    const std::string & senderNickname
)

设置发送者昵称

Parameters:

• senderNickname

function getSenderNickname

std::string getSenderNickname()

获取发送者昵称

Return: std::string

function setGroupMemberList

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

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

Parameters:

• groupMemberList

function getGroupMemberList

std::vector< int64_t > getGroupMemberList()

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

Return: std::vector<int64_t>

function addGroupMember

void addGroupMember(
    int64_t id
)

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

function removeGroupMember

void removeGroupMember(
    int64_t id
)

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

Return: std::vector<int64_t>

function clearGroupMemberList

void clearGroupMemberList()

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

function setIOSConfig

void setIOSConfig(
    const std::string & iosConfig
)

设置IOS系统配置信息

Parameters:

• iosConfig

function getIOSConfig

std::string getIOSConfig()

获取IOS系统配置信息

Return: std::string

function setAndroidConfig

void setAndroidConfig(
    const std::string & androidConfig
)

设置Android系统配置信息

Parameters:

• androidConfig

function getAndroidConfig

std::string getAndroidConfig()

获取Android系统配置信息

Return: std::string

function setPushShowBeginTime

void setPushShowBeginTime(
    int beginTime
)

设置推送显示开始时间

Parameters:

• beginTime

function getPushShowBeginTime

int getPushShowBeginTime()

获取推送显示开始时间

Return: int

function setPushShowEndTime

void setPushShowEndTime(
    int endTime
)

设置推送显示结束时间

Parameters:

• endTime

function getPushShowEndTime

int getPushShowEndTime()

获取推送显示结束时间

Return: int

function setPushTitle

void setPushTitle(
    const std::string & pushTitle
)

设置推送标题

Parameters:

• pushTitle

function getPushTitle

std::string getPushTitle()

获取推送标题

Return: std::string

function isSilence

bool isSilence()

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

Return: bool

function getBadgeCountType

BadgeCountType getBadgeCountType()

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

Return: BadgeCountType

function getBadgeCount

int getBadgeCount(
    int count
)

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

Return: int

function setUsername

void setUsername(
    const std::string & username
)

设置用户名

Parameters:

• username

function getUsername

std::string getUsername()

获得用户名

Return: std::string

function serialize

std::string serialize() const

序列化操作

Return: std::string

function createMessageConfig

static BMXMessageConfigPtr createMessageConfig(
    bool mentionAll
)

Friends

friend encodeBMXMessageConfig

friend std::string encodeBMXMessageConfig(
    BMXMessageConfigPtr 
);

friend decodeBMXMessageConfig

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

---

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