floo::BMXGroup

群组

#include <bmx_group.h>

Inherits from BMXBaseObject

Public Types

	Name
enum class	InvitationStatus { Pending, Accepted, Declined} 群邀请状态
enum class	ApplicationStatus { Pending, Accepted, Declined} 群申请状态
enum class	MsgPushMode { All, None, AdminOrAt, Admin, At} 消息通知类型
enum class	ModifyMode { AdminOnly, Open} 群信息修改模式
enum class	JoinAuthMode { Open, NeedApproval, RejectAll} 进群验证方式
enum class	InviteMode { AdminOnly, Open} 邀请入群模式
enum class	UpdateInfoType { UnKnown, Name, Description, Avatar, Owner, Ext, NickName, ModifyMode, JoinAuthMode, InviteMode, MsgPushMode, MsgMuteMode, ReadAckMode, HistoryVisibleMode, BanExpireTime} 群组信息更新类型
enum class	GroupStatus { Normal, Destroyed} 群组状态
enum class	MsgMuteMode { None, MuteNotification, MuteChat} 群组消息屏蔽模式
enum class	MemberRoleType { GroupMember, GroupAdmin, GroupOwner, NotGroupMember}
enum class	GroupType { Private, Public, Chatroom}
typedef std::shared_ptr< [Member] >	MemberPtr
typedef std::vector< MemberPtr >	MemberList
typedef std::shared_ptr< [BannedMember] >	BannedMemberPtr
typedef std::vector< BannedMemberPtr >	BannedMemberList
typedef std::shared_ptr< [SharedFile] >	SharedFilePtr
typedef std::vector< SharedFilePtr >	SharedFileList
typedef std::shared_ptr< [Announcement] >	AnnouncementPtr
typedef std::vector< AnnouncementPtr >	AnnouncementList
typedef std::shared_ptr< [Invitation] >	InvitationPtr
typedef std::vector< InvitationPtr >	InvitationList
typedef std::shared_ptr< [Application] >	ApplicationPtr
typedef std::vector< ApplicationPtr >	ApplicationList

Public Functions

	Name
virtual	~BMXGroup() 析构函数
virtual int64_t	groupId() =0 群Id
virtual GroupType	groupType() =0 当前群组的群组类型（Private 私有群组，Public 公开群组，Chatroom 聊天室）
virtual const std::string &	myNickname() =0 在群里的昵称
virtual const std::string &	name() =0 群名称
virtual const std::string &	description() =0 群描述
virtual std::string	avatarRatelUrl() =0 群头像Ratel服务器Url
virtual std::string	avatarUrl() =0 群头像服务器Url
virtual std::string	avatarPath() =0 群头像下载后的本地路径
virtual std::string	avatarThumbnailUrl() =0 群头像缩略图服务器Url
virtual std::string	avatarThumbnailPath() =0 群头像缩略图下载后的本地路径
virtual int64_t	createTime() =0 群创建时间
virtual const JSON &	extension() =0 群扩展信息
virtual int64_t	ownerId() =0 群Owner
virtual int	capacity() =0 最大人数
virtual int	membersCount() =0 群成员数量，包含Owner，admins 和members
virtual int	adminsCount() =0 群管理员数量
virtual int	blockListSize() =0 黑名单数量
virtual int	bannedListSize() =0 禁言数量
virtual int	sharedFilesCount() =0 群共享文件数量
virtual int64_t	latestAnnouncementId() =0 最新群公告id
virtual MsgPushMode	msgPushMode() =0 群消息通知类型
virtual ModifyMode	modifyMode() =0 群信息修改模式
virtual JoinAuthMode	joinAuthMode() =0 入群审批模式
virtual InviteMode	inviteMode() =0 入群邀请模式
virtual MsgMuteMode	msgMuteMode() =0 群消息屏蔽模式
virtual GroupStatus	groupStatus() =0 当前群组的状态。（Normal 正常， Destroyed 以销毁）
virtual bool	isMember() =0 Deprecated use roleType instead.
virtual bool	enableReadAck() =0 是否开启群消息已读功能
virtual bool	historyVisible() =0 是否可以加载显示历史聊天记录
virtual MemberRoleType	roleType() =0 成员在群组内的角色类型
virtual int64_t	banExpireTime() =0 群组全员禁言到期时间

Protected Functions

	Name
	BMXGroup()

Public Types Documentation

enum InvitationStatus

Enumerator	Value	Description
Pending		请求待处理
Accepted		请求已接受
Declined		请求已拒绝

群邀请状态

enum ApplicationStatus

Enumerator	Value	Description
Pending		请求待处理
Accepted		请求已接受
Declined		请求已拒绝

群申请状态

enum MsgPushMode

Enumerator	Value	Description
All		通知所有群消息
None		所有消息都不通知
AdminOrAt		只通知管理员或者被@消息
Admin		只通知知管理员消息
At		只通知被@消息

消息通知类型

enum ModifyMode

Enumerator	Value	Description
AdminOnly		只有管理员可以
Open		所有群成员都可以修改

群信息修改模式

enum JoinAuthMode

Enumerator	Value	Description
Open		无需验证
NeedApproval		需要管理员批准
RejectAll		拒绝所有申请

进群验证方式

enum InviteMode

Enumerator	Value	Description
AdminOnly		只有管理员可以邀请他人进群
Open		所有人都可以邀请他人进群

邀请入群模式

enum UpdateInfoType

Enumerator	Value	Description
UnKnown		默认初始化值
Name		修改群名称
Description		修改群描述
Avatar		修改群头像
Owner		修改群主
Ext		修改群扩展
NickName		群成员修改昵称
ModifyMode		修改群信息模式
JoinAuthMode		修改进群验证方式
InviteMode		修改邀请入群模式
MsgPushMode		修改群消息推送类型
MsgMuteMode		修改是否提醒消息
ReadAckMode		是否开启群消息已读功能
HistoryVisibleMode		新群成员是否可见群历史聊天记录
BanExpireTime		群组全员禁言到期时间

群组信息更新类型

enum GroupStatus

Enumerator	Value	Description
Normal		群组状态正常
Destroyed		群组已销毁

群组状态

enum MsgMuteMode

Enumerator	Value	Description
None		不屏蔽
MuteNotification		屏蔽本地消息通知
MuteChat		屏蔽消息，不接收消息

群组消息屏蔽模式

enum MemberRoleType

Enumerator	Value	Description
GroupMember		群成员
GroupAdmin		群管理员
GroupOwner		群主
NotGroupMember		非群成员

enum GroupType

Enumerator	Value	Description
Private		私有群组
Public		公开群组(现在暂时没有开放次类型群组)
Chatroom		聊天室

typedef MemberPtr

typedef std::shared_ptr<Member> floo::BMXGroup::MemberPtr;

typedef MemberList

typedef std::vector<MemberPtr> floo::BMXGroup::MemberList;

typedef BannedMemberPtr

typedef std::shared_ptr<BannedMember> floo::BMXGroup::BannedMemberPtr;

typedef BannedMemberList

typedef std::vector<BannedMemberPtr> floo::BMXGroup::BannedMemberList;

typedef SharedFilePtr

typedef std::shared_ptr<SharedFile> floo::BMXGroup::SharedFilePtr;

typedef SharedFileList

typedef std::vector<SharedFilePtr> floo::BMXGroup::SharedFileList;

typedef AnnouncementPtr

typedef std::shared_ptr<Announcement> floo::BMXGroup::AnnouncementPtr;

typedef AnnouncementList

typedef std::vector<AnnouncementPtr> floo::BMXGroup::AnnouncementList;

typedef InvitationPtr

typedef std::shared_ptr<Invitation> floo::BMXGroup::InvitationPtr;

typedef InvitationList

typedef std::vector<InvitationPtr> floo::BMXGroup::InvitationList;

typedef ApplicationPtr

typedef std::shared_ptr<Application> floo::BMXGroup::ApplicationPtr;

typedef ApplicationList

typedef std::vector<ApplicationPtr> floo::BMXGroup::ApplicationList;

Public Functions Documentation

function ~BMXGroup

inline virtual ~BMXGroup()

析构函数

function groupId

virtual int64_t groupId() =0

群Id

Return: int64_t

function groupType

virtual GroupType groupType() =0

当前群组的群组类型（Private 私有群组，Public 公开群组，Chatroom 聊天室）

Return: GroupType

function myNickname

virtual const std::string & myNickname() =0

在群里的昵称

Return: std::string

function name

virtual const std::string & name() =0

群名称

Return: std::string

function description

virtual const std::string & description() =0

群描述

Return: std::string

function avatarRatelUrl

virtual std::string avatarRatelUrl() =0

群头像Ratel服务器Url

Return: std::string

function avatarUrl

virtual std::string avatarUrl() =0

群头像服务器Url

Return: std::string

function avatarPath

virtual std::string avatarPath() =0

群头像下载后的本地路径

Return: std::string

function avatarThumbnailUrl

virtual std::string avatarThumbnailUrl() =0

群头像缩略图服务器Url

Return: std::string

function avatarThumbnailPath

virtual std::string avatarThumbnailPath() =0

群头像缩略图下载后的本地路径

Return: std::string

function createTime

virtual int64_t createTime() =0

群创建时间

Return: int64_t

function extension

virtual const JSON & extension() =0

群扩展信息

Return: JSON(std::string)

function ownerId

virtual int64_t ownerId() =0

群Owner

Return: int64_t

function capacity

virtual int capacity() =0

最大人数

Return: int

function membersCount

virtual int membersCount() =0

群成员数量，包含Owner，admins 和members

Return: int

function adminsCount

virtual int adminsCount() =0

群管理员数量

Return: int

function blockListSize

virtual int blockListSize() =0

黑名单数量

Return: int

function bannedListSize

virtual int bannedListSize() =0

禁言数量

Return: int

function sharedFilesCount

virtual int sharedFilesCount() =0

群共享文件数量

Return: int

function latestAnnouncementId

virtual int64_t latestAnnouncementId() =0

最新群公告id

Return: int64_t

function msgPushMode

virtual MsgPushMode msgPushMode() =0

群消息通知类型

Return: MsgPushMode

function modifyMode

virtual ModifyMode modifyMode() =0

群信息修改模式

Return: ModifyMode

function joinAuthMode

virtual JoinAuthMode joinAuthMode() =0

入群审批模式

Return: JoinAuthMode

function inviteMode

virtual InviteMode inviteMode() =0

入群邀请模式

Return: InviteMode

function msgMuteMode

virtual MsgMuteMode msgMuteMode() =0

群消息屏蔽模式

Return: MsgMuteMode

function groupStatus

virtual GroupStatus groupStatus() =0

当前群组的状态。（Normal 正常， Destroyed 以销毁）

Return: GroupStatus

function isMember

virtual bool isMember() =0

Deprecated use roleType instead.

Return: bool

当前用户是否是群成员

function enableReadAck

virtual bool enableReadAck() =0

是否开启群消息已读功能

Return: bool

function historyVisible

virtual bool historyVisible() =0

是否可以加载显示历史聊天记录

Return: bool

function roleType

virtual MemberRoleType roleType() =0

成员在群组内的角色类型

Return: MemberRoleType

function banExpireTime

virtual int64_t banExpireTime() =0

群组全员禁言到期时间

Return: int64_t

Protected Functions Documentation

function BMXGroup

inline BMXGroup()

---

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