floo2
Classes | Public Types | Public Member Functions | List of all members
floo::BMXGroup Class Referenceabstract

群组 More...

#include <bmx_group.h>

Inheritance diagram for floo::BMXGroup:
floo::BMXBaseObject

Classes

struct  Announcement
 群公告 More...
 
struct  Application
 群申请 More...
 
struct  BannedMember
 群禁言成员 More...
 
struct  Invitation
 群邀请 More...
 
struct  Member
 群成员 More...
 
struct  SharedFile
 群共享文件 More...
 

Public Types

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

Public Member Functions

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

Detailed Description

群组

Member Enumeration Documentation

◆ ApplicationStatus

群申请状态

Enumerator
Pending 

请求待处理

Accepted 

请求已接受

Declined 

请求已拒绝

◆ GroupStatus

群组状态

Enumerator
Normal 

群组状态正常

Destroyed 

群组已销毁

◆ GroupType

Enumerator
Private 

私有群组

Public 

公开群组(现在暂时没有开放次类型群组)

Chatroom 

聊天室

◆ InvitationStatus

群邀请状态

Enumerator
Pending 

请求待处理

Accepted 

请求已接受

Declined 

请求已拒绝

◆ InviteMode

邀请入群模式

Enumerator
AdminOnly 

只有管理员可以邀请他人进群

Open 

所有人都可以邀请他人进群

◆ JoinAuthMode

进群验证方式

Enumerator
Open 

无需验证

NeedApproval 

需要管理员批准

RejectAll 

拒绝所有申请

◆ MemberRoleType

Enumerator
GroupMember 

群成员

GroupAdmin 

群管理员

GroupOwner 

群主

NotGroupMember 

非群成员

◆ ModifyMode

群信息修改模式

Enumerator
AdminOnly 

只有管理员可以

Open 

所有群成员都可以修改

◆ MsgMuteMode

群组消息屏蔽模式

Enumerator
None 

不屏蔽

MuteNotification 

屏蔽本地消息通知

MuteChat 

屏蔽消息,不接收消息

◆ MsgPushMode

消息通知类型

Enumerator
All 

通知所有群消息

None 

所有消息都不通知

AdminOrAt 

只通知管理员或者被@消息

Admin 

只通知知管理员消息

At 

只通知被@消息

◆ UpdateInfoType

群组信息更新类型

Enumerator
UnKnown 

默认初始化值

Name 

修改群名称

Description 

修改群描述

Avatar 

修改群头像

Owner 

修改群主

Ext 

修改群扩展

NickName 

群成员修改昵称

ModifyMode 

修改群信息模式

JoinAuthMode 

修改进群验证方式

InviteMode 

修改邀请入群模式

MsgPushMode 

修改群消息推送类型

MsgMuteMode 

修改是否提醒消息

ReadAckMode 

是否开启群消息已读功能

HistoryVisibleMode 

新群成员是否可见群历史聊天记录

Member Function Documentation

◆ adminsCount()

virtual int floo::BMXGroup::adminsCount ( )
pure virtual

群管理员数量

Returns
int

◆ avatarPath()

virtual std::string floo::BMXGroup::avatarPath ( )
pure virtual

群头像下载后的本地路径

Returns
std::string

◆ avatarRatelUrl()

virtual std::string floo::BMXGroup::avatarRatelUrl ( )
pure virtual

群头像Ratel服务器Url

Returns
std::string

◆ avatarThumbnailPath()

virtual std::string floo::BMXGroup::avatarThumbnailPath ( )
pure virtual

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

Returns
std::string

◆ avatarThumbnailUrl()

virtual std::string floo::BMXGroup::avatarThumbnailUrl ( )
pure virtual

群头像缩略图服务器Url

Returns
std::string

◆ avatarUrl()

virtual std::string floo::BMXGroup::avatarUrl ( )
pure virtual

群头像服务器Url

Returns
std::string

◆ bannedListSize()

virtual int floo::BMXGroup::bannedListSize ( )
pure virtual

禁言数量

Returns
int

◆ blockListSize()

virtual int floo::BMXGroup::blockListSize ( )
pure virtual

黑名单数量

Returns
int

◆ capacity()

virtual int floo::BMXGroup::capacity ( )
pure virtual

最大人数

Returns
int

◆ createTime()

virtual int64_t floo::BMXGroup::createTime ( )
pure virtual

群创建时间

Returns
int64_t

◆ description()

virtual const std::string& floo::BMXGroup::description ( )
pure virtual

群描述

Returns
std::string

◆ enableReadAck()

virtual bool floo::BMXGroup::enableReadAck ( )
pure virtual

是否开启群消息已读功能

Returns
bool

◆ extension()

virtual const JSON& floo::BMXGroup::extension ( )
pure virtual

群扩展信息

Returns
JSON(std::string)

◆ groupId()

virtual int64_t floo::BMXGroup::groupId ( )
pure virtual

群Id

Returns
int64_t

◆ groupStatus()

virtual GroupStatus floo::BMXGroup::groupStatus ( )
pure virtual

当前群组的状态。(Normal 正常, Destroyed 以销毁)

Returns
GroupStatus

◆ groupType()

virtual GroupType floo::BMXGroup::groupType ( )
pure virtual

当前群组的群组类型(Private 私有群组,Public 公开群组,Chatroom 聊天室)

Returns
GroupType

◆ historyVisible()

virtual bool floo::BMXGroup::historyVisible ( )
pure virtual

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

Returns
bool

◆ inviteMode()

virtual InviteMode floo::BMXGroup::inviteMode ( )
pure virtual

入群邀请模式

Returns
InviteMode

◆ isMember()

virtual bool floo::BMXGroup::isMember ( )
pure virtual

当前用户是否是群成员

Deprecated use roleType instead.

Returns
bool

◆ joinAuthMode()

virtual JoinAuthMode floo::BMXGroup::joinAuthMode ( )
pure virtual

入群审批模式

Returns
JoinAuthMode

◆ latestAnnouncementId()

virtual int64_t floo::BMXGroup::latestAnnouncementId ( )
pure virtual

最新群公告id

Returns
int64_t

◆ membersCount()

virtual int floo::BMXGroup::membersCount ( )
pure virtual

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

Returns
int

◆ modifyMode()

virtual ModifyMode floo::BMXGroup::modifyMode ( )
pure virtual

群信息修改模式

Returns
ModifyMode

◆ msgMuteMode()

virtual MsgMuteMode floo::BMXGroup::msgMuteMode ( )
pure virtual

群消息屏蔽模式

Returns
MsgMuteMode

◆ msgPushMode()

virtual MsgPushMode floo::BMXGroup::msgPushMode ( )
pure virtual

群消息通知类型

Returns
MsgPushMode

◆ myNickname()

virtual const std::string& floo::BMXGroup::myNickname ( )
pure virtual

在群里的昵称

Returns
std::string

◆ name()

virtual const std::string& floo::BMXGroup::name ( )
pure virtual

群名称

Returns
std::string

◆ ownerId()

virtual int64_t floo::BMXGroup::ownerId ( )
pure virtual

群Owner

Returns
int64_t

◆ roleType()

virtual MemberRoleType floo::BMXGroup::roleType ( )
pure virtual

成员在群组内的角色类型

Returns
MemberRoleType

◆ sharedFilesCount()

virtual int floo::BMXGroup::sharedFilesCount ( )
pure virtual

群共享文件数量

Returns
int

The documentation for this class was generated from the following file: