floo::BMXGroup

Group

#include <bmx_group.h>

Inherits from BMXBaseObject

Public Types

Public Functions

Protected Functions

Public Types Documentation

enum InvitationStatus

Group invitation state

enum ApplicationStatus

Group application state

enum MsgPushMode

Message notification type

enum ModifyMode

Group information modification mode

enum JoinAuthMode

Group joining authentication mode

enum InviteMode

Group invitation mode

enum UpdateInfoType

Group information update type

enum GroupStatus

Grouping state

enum MsgMuteMode

Group message blocking mode

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

Destructor

Example:

function groupId

virtual int64_t groupId() =0

Group 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

Type of the current group (Private, Public, Chatroom)

Return: GroupType

Example:

function myNickname

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

Group member nickname of mine

Return: std::string

Example:

function name

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

Group name

Return: std::string

Example:

function description

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

Group description

Return: std::string

Example:

function avatarRatelUrl

virtual std::string avatarRatelUrl() =0

Url for group avatar Ratel server

Return: std::string

Example:

function avatarUrl

virtual std::string avatarUrl() =0

Url for group avatar server

Return: std::string

Example:

function avatarPath

virtual std::string avatarPath() =0

Local path of downloaded group avatar

Return: std::string

Example:

function avatarThumbnailUrl

virtual std::string avatarThumbnailUrl() =0

Url for group avatar thumbnail server

Return: std::string

Example:

function avatarThumbnailPath

virtual std::string avatarThumbnailPath() =0

Local path of downloaded group avatar thumbnail

Return: std::string

Example:

function createTime

virtual int64_t createTime() =0

Group creation time

Return: int64_t

Example:

function extension

virtual const JSON & extension() =0

Group extension information

Return: JSON(std::string)

Example:

function ownerId

virtual int64_t ownerId() =0

Group Owner

Return: int64_t

Example:

function capacity

virtual int capacity() =0

Maximum number of group members

Return: int

Example:

function membersCount

virtual int membersCount() =0

Number of group members, including Owner, Admins and Members

Return: int

Example:

function adminsCount

virtual int adminsCount() =0

Number of group admins

Return: int

Example:

function blockListSize

virtual int blockListSize() =0

Blacklisted user-number

Return: int

Example:

function bannedListSize

virtual int bannedListSize() =0

Banned user-number

Return: int

Example:

function sharedFilesCount

virtual int sharedFilesCount() =0

Shared file-number in group

Return: int

Example:

function latestAnnouncementId

virtual int64_t latestAnnouncementId() =0

Latest group announcement id

Return: int64_t

Example:

function msgPushMode

virtual MsgPushMode msgPushMode() =0

Group message notification type

Return: MsgPushMode

Example:

function modifyMode

virtual ModifyMode modifyMode() =0

Group information modification mode

Return: ModifyMode

Example:

function joinAuthMode

virtual JoinAuthMode joinAuthMode() =0

Join approval mode

Return: JoinAuthMode

Example:

function inviteMode

virtual InviteMode inviteMode() =0

Group invitation mode

Return: InviteMode

Example:

function msgMuteMode

virtual MsgMuteMode msgMuteMode() =0

Group message blocking mode

Return: MsgMuteMode

Example:

function groupStatus

virtual GroupStatus groupStatus() =0

state of the current group. (Normal, Destroyed)

Return: GroupStatus

Example:

function isMember

virtual bool isMember() =0

Deprecated use roleType instead.

Return: bool

Whether the current user is a group member

Example:

function enableReadAck

virtual bool enableReadAck() =0

Whether group message read acknowledgement feature enabled

Return: bool

Example:

function historyVisible

virtual bool historyVisible() =0

Whether to load and display the chat history

Return: bool

Example:

function roleType

virtual MemberRoleType roleType() =0

Type of a member role in group

Return: MemberRoleType

Example:

function banExpireTime

virtual int64_t banExpireTime() =0

Expiration time of banning all group members

Return: int64_t

Protected Functions Documentation

Example:

function BMXGroup

inline BMXGroup()

Example:

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