floo::BMXGroup

群组

#include <bmx_group.h>

Inherits from BMXBaseObject

Public Types

Public Functions

Protected Functions

Public Types Documentation

enum InvitationStatus

群邀请状态

enum ApplicationStatus

群申请状态

enum MsgPushMode

消息通知类型

enum ModifyMode

群信息修改模式

enum JoinAuthMode

进群验证方式

enum InviteMode

邀请入群模式

enum UpdateInfoType

群组信息更新类型

enum GroupStatus

群组状态

enum MsgMuteMode

群组消息屏蔽模式

enum MemberRoleType

enum GroupType

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()

析构函数

Example:

function groupId

virtual int64_t groupId() =0

群Id

Return: int64_t

Example:

mvwaddstr(notifyWindow, 2, 1, std::to_string(group->groupId()).c_str());

mvwaddstr(notifyWindow, 2, 1, std::to_string(group->groupId()).c_str());

mvwaddstr(notifyWindow, 2, 1, std::to_string(group->groupId()).c_str());

mvwaddstr(notifyWindow, 2, 1, std::to_string(group->groupId()).c_str());

function groupType

virtual GroupType groupType() =0

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

Return: GroupType

Example:

function myNickname

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

在群里的昵称

Return: std::string

Example:

function name

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

群名称

Return: std::string

Example:

function description

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

群描述

Return: std::string

Example:

function avatarRatelUrl

virtual std::string avatarRatelUrl() =0

群头像Ratel服务器Url

Return: std::string

Example:

function avatarUrl

virtual std::string avatarUrl() =0

群头像服务器Url

Return: std::string

Example:

function avatarPath

virtual std::string avatarPath() =0

群头像下载后的本地路径

Return: std::string

Example:

function avatarThumbnailUrl

virtual std::string avatarThumbnailUrl() =0

群头像缩略图服务器Url

Return: std::string

Example:

function avatarThumbnailPath

virtual std::string avatarThumbnailPath() =0

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

Return: std::string

Example:

function createTime

virtual int64_t createTime() =0

群创建时间

Return: int64_t

Example:

function extension

virtual const JSON & extension() =0

群扩展信息

Return: JSON(std::string)

Example:

function ownerId

virtual int64_t ownerId() =0

群Owner

Return: int64_t

Example:

function capacity

virtual int capacity() =0

最大人数

Return: int

Example:

function membersCount

virtual int membersCount() =0

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

Return: int

Example:

function adminsCount

virtual int adminsCount() =0

群管理员数量

Return: int

Example:

function blockListSize

virtual int blockListSize() =0

黑名单数量

Return: int

Example:

function bannedListSize

virtual int bannedListSize() =0

禁言数量

Return: int

Example:

function sharedFilesCount

virtual int sharedFilesCount() =0

群共享文件数量

Return: int

Example:

function latestAnnouncementId

virtual int64_t latestAnnouncementId() =0

最新群公告id

Return: int64_t

Example:

function msgPushMode

virtual MsgPushMode msgPushMode() =0

群消息通知类型

Return: MsgPushMode

Example:

function modifyMode

virtual ModifyMode modifyMode() =0

群信息修改模式

Return: ModifyMode

Example:

function joinAuthMode

virtual JoinAuthMode joinAuthMode() =0

入群审批模式

Return: JoinAuthMode

Example:

function inviteMode

virtual InviteMode inviteMode() =0

入群邀请模式

Return: InviteMode

Example:

function msgMuteMode

virtual MsgMuteMode msgMuteMode() =0

群消息屏蔽模式

Return: MsgMuteMode

Example:

function groupStatus

virtual GroupStatus groupStatus() =0

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

Return: GroupStatus

Example:

function isMember

virtual bool isMember() =0

Deprecated use roleType instead.

Return: bool

当前用户是否是群成员

Example:

function enableReadAck

virtual bool enableReadAck() =0

是否开启群消息已读功能

Return: bool

Example:

function historyVisible

virtual bool historyVisible() =0

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

Return: bool

Example:

function roleType

virtual MemberRoleType roleType() =0

成员在群组内的角色类型

Return: MemberRoleType

Example:

function banExpireTime

virtual int64_t banExpireTime() =0

群组全员禁言到期时间

Return: int64_t

Protected Functions Documentation

Example:

function BMXGroup

inline BMXGroup()

Example:

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