蓝莺开发者
Web & Mini ProgramiOSAndroidC++Server API
API 参考文档/C++

floo::BMXGroup#

群组

#include <bmx_group.h>

Inherits from BMXBaseObject

Public Types#

Name
enum classInvitationStatus { Pending, Accepted, Declined}
群邀请状态
enum classApplicationStatus { Pending, Accepted, Declined}
群申请状态
enum classMsgPushMode { All, None, AdminOrAt, Admin, At}
消息通知类型
enum classModifyMode { AdminOnly, Open}
群信息修改模式
enum classJoinAuthMode { Open, NeedApproval, RejectAll}
进群验证方式
enum classInviteMode { AdminOnly, Open}
邀请入群模式
enum classUpdateInfoType { UnKnown, Name, Description, Avatar, Owner, Ext, NickName, ModifyMode, JoinAuthMode, InviteMode, MsgPushMode, MsgMuteMode, ReadAckMode, HistoryVisibleMode, BanExpireTime}
群组信息更新类型
enum classGroupStatus { Normal, Destroyed}
群组状态
enum classMsgMuteMode { None, MuteNotification, MuteChat}
群组消息屏蔽模式
enum classMemberRoleType { GroupMember, GroupAdmin, GroupOwner, NotGroupMember}
enum classGroupType { 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_tgroupId() =0
群Id
virtual GroupTypegroupType() =0
当前群组的群组类型（Private 私有群组，Public 公开群组，Chatroom 聊天室）
virtual const std::string &myNickname() =0
在群里的昵称
virtual const std::string &name() =0
群名称
virtual const std::string &description() =0
群描述
virtual std::stringavatarRatelUrl() =0
群头像Ratel服务器Url
virtual std::stringavatarUrl() =0
群头像服务器Url
virtual std::stringavatarPath() =0
群头像下载后的本地路径
virtual std::stringavatarThumbnailUrl() =0
群头像缩略图服务器Url
virtual std::stringavatarThumbnailPath() =0
群头像缩略图下载后的本地路径
virtual int64_tcreateTime() =0
群创建时间
virtual const JSON &extension() =0
群扩展信息
virtual int64_townerId() =0
群Owner
virtual intcapacity() =0
最大人数
virtual intmembersCount() =0
群成员数量，包含Owner，admins 和members
virtual intadminsCount() =0
群管理员数量
virtual intblockListSize() =0
黑名单数量
virtual intbannedListSize() =0
禁言数量
virtual intsharedFilesCount() =0
群共享文件数量
virtual int64_tlatestAnnouncementId() =0
最新群公告id
virtual MsgPushModemsgPushMode() =0
群消息通知类型
virtual ModifyModemodifyMode() =0
群信息修改模式
virtual JoinAuthModejoinAuthMode() =0
入群审批模式
virtual InviteModeinviteMode() =0
入群邀请模式
virtual MsgMuteModemsgMuteMode() =0
群消息屏蔽模式
virtual GroupStatusgroupStatus() =0
当前群组的状态。（Normal 正常， Destroyed 以销毁）
virtual boolisMember() =0
Deprecated use roleType instead.
virtual boolenableReadAck() =0
是否开启群消息已读功能
virtual boolhistoryVisible() =0
是否可以加载显示历史聊天记录
virtual MemberRoleTyperoleType() =0
成员在群组内的角色类型
virtual int64_tbanExpireTime() =0
群组全员禁言到期时间

Protected Functions#

Name
BMXGroup()

Public Types Documentation#

enum InvitationStatus#

EnumeratorValueDescription
Pending请求待处理
Accepted请求已接受
Declined请求已拒绝

群邀请状态

enum ApplicationStatus#

EnumeratorValueDescription
Pending请求待处理
Accepted请求已接受
Declined请求已拒绝

群申请状态

enum MsgPushMode#

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

消息通知类型

enum ModifyMode#

EnumeratorValueDescription
AdminOnly只有管理员可以
Open所有群成员都可以修改

群信息修改模式

enum JoinAuthMode#

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

进群验证方式

enum InviteMode#

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

邀请入群模式

enum UpdateInfoType#

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

群组信息更新类型

enum GroupStatus#

EnumeratorValueDescription
Normal群组状态正常
Destroyed群组已销毁

群组状态

enum MsgMuteMode#

EnumeratorValueDescription
None不屏蔽
MuteNotification屏蔽本地消息通知
MuteChat屏蔽消息，不接收消息

群组消息屏蔽模式

enum MemberRoleType#

EnumeratorValueDescription
GroupMember群成员
GroupAdmin群管理员
GroupOwner群主
NotGroupMember非群成员

enum GroupType#

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

析构函数

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="~BMXGroup" %}{% endlanying_code_snippet %}

function groupId#

virtual int64_t groupId() =0

群Id

Return: int64_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="groupId" %}{% endlanying_code_snippet %}

function groupType#

virtual GroupType groupType() =0

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

Return: GroupType

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="groupType" %}{% endlanying_code_snippet %}

function myNickname#

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

在群里的昵称

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="myNickname" %}{% endlanying_code_snippet %}

function name#

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

群名称

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="name" %}{% endlanying_code_snippet %}

function description#

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

群描述

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="description" %}{% endlanying_code_snippet %}

function avatarRatelUrl#

virtual std::string avatarRatelUrl() =0

群头像Ratel服务器Url

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="avatarRatelUrl" %}{% endlanying_code_snippet %}

function avatarUrl#

virtual std::string avatarUrl() =0

群头像服务器Url

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="avatarUrl" %}{% endlanying_code_snippet %}

function avatarPath#

virtual std::string avatarPath() =0

群头像下载后的本地路径

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="avatarPath" %}{% endlanying_code_snippet %}

function avatarThumbnailUrl#

virtual std::string avatarThumbnailUrl() =0

群头像缩略图服务器Url

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="avatarThumbnailUrl" %}{% endlanying_code_snippet %}

function avatarThumbnailPath#

virtual std::string avatarThumbnailPath() =0

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

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="avatarThumbnailPath" %}{% endlanying_code_snippet %}

function createTime#

virtual int64_t createTime() =0

群创建时间

Return: int64_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="createTime" %}{% endlanying_code_snippet %}

function extension#

virtual const JSON & extension() =0

群扩展信息

Return: JSON(std::string)

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="extension" %}{% endlanying_code_snippet %}

function ownerId#

virtual int64_t ownerId() =0

群Owner

Return: int64_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="ownerId" %}{% endlanying_code_snippet %}

function capacity#

virtual int capacity() =0

最大人数

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="capacity" %}{% endlanying_code_snippet %}

function membersCount#

virtual int membersCount() =0

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

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="membersCount" %}{% endlanying_code_snippet %}

function adminsCount#

virtual int adminsCount() =0

群管理员数量

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="adminsCount" %}{% endlanying_code_snippet %}

function blockListSize#

virtual int blockListSize() =0

黑名单数量

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="blockListSize" %}{% endlanying_code_snippet %}

function bannedListSize#

virtual int bannedListSize() =0

禁言数量

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="bannedListSize" %}{% endlanying_code_snippet %}

function sharedFilesCount#

virtual int sharedFilesCount() =0

群共享文件数量

Return: int

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="sharedFilesCount" %}{% endlanying_code_snippet %}

function latestAnnouncementId#

virtual int64_t latestAnnouncementId() =0

最新群公告id

Return: int64_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="latestAnnouncementId" %}{% endlanying_code_snippet %}

function msgPushMode#

virtual MsgPushMode msgPushMode() =0

群消息通知类型

Return: MsgPushMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="msgPushMode" %}{% endlanying_code_snippet %}

function modifyMode#

virtual ModifyMode modifyMode() =0

群信息修改模式

Return: ModifyMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="modifyMode" %}{% endlanying_code_snippet %}

function joinAuthMode#

virtual JoinAuthMode joinAuthMode() =0

入群审批模式

Return: JoinAuthMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="joinAuthMode" %}{% endlanying_code_snippet %}

function inviteMode#

virtual InviteMode inviteMode() =0

入群邀请模式

Return: InviteMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="inviteMode" %}{% endlanying_code_snippet %}

function msgMuteMode#

virtual MsgMuteMode msgMuteMode() =0

群消息屏蔽模式

Return: MsgMuteMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="msgMuteMode" %}{% endlanying_code_snippet %}

function groupStatus#

virtual GroupStatus groupStatus() =0

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

Return: GroupStatus

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="groupStatus" %}{% endlanying_code_snippet %}

function isMember#

virtual bool isMember() =0

Deprecated use roleType instead.

Return: bool

当前用户是否是群成员

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="isMember" %}{% endlanying_code_snippet %}

function enableReadAck#

virtual bool enableReadAck() =0

是否开启群消息已读功能

Return: bool

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="enableReadAck" %}{% endlanying_code_snippet %}

function historyVisible#

virtual bool historyVisible() =0

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

Return: bool

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="historyVisible" %}{% endlanying_code_snippet %}

function roleType#

virtual MemberRoleType roleType() =0

成员在群组内的角色类型

Return: MemberRoleType

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="roleType" %}{% endlanying_code_snippet %}

function banExpireTime#

virtual int64_t banExpireTime() =0

群组全员禁言到期时间

Return: int64_t

Protected Functions Documentation#

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="banExpireTime" %}{% endlanying_code_snippet %}

function BMXGroup#

inline BMXGroup()

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXGroup",function="BMXGroup" %}{% endlanying_code_snippet %}

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

自动生成的 API 内容，仅在必要位置补充精简的 AI 解释。