im::floo::floolib::BMXGroup#

Group

Inherits from BMXBaseObject

Public Classes#

Public Functions#

Protected Functions#

Public Attributes#

Public Functions Documentation#

function BMXGroup#

inline BMXGroup()

function delete#

inline synchronized void delete()

function groupId#

inline long groupId()

Group Id

Return: int64_t

function groupType#

inline BMXGroup.GroupType groupType()

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

Return: [GroupType]

function myNickname#

inline String myNickname()

Group member nickname of mine

Return: std::string

function name#

inline String name()

Group name

Return: std::string

function description#

inline String description()

Group description

Return: std::string

function avatarRatelUrl#

inline String avatarRatelUrl()

Ratel address of group avatar

Return: std::string

function avatarUrl#

inline String avatarUrl()

Group avatar

Return: std::string

function avatarPath#

inline String avatarPath()

Local path of downloaded group avatar

Return: std::string

function avatarThumbnailUrl#

inline String avatarThumbnailUrl()

Group avatar thumbnail address

Return: std::string

function avatarThumbnailPath#

inline String avatarThumbnailPath()

Local path of downloaded group avatar thumbnail

Return: std::string

function createTime#

inline long createTime()

Group creation time

Return: int64_t

function extension#

inline String extension()

Group extension information

Return: JSON(std::string)

function ownerId#

inline long ownerId()

Group Owner

Return: int64_t

function capacity#

inline int capacity()

Maximum number of group members

Return: int

function membersCount#

inline int membersCount()

Number of group members, including Owner, Admins and Members

Return: int

function adminsCount#

inline int adminsCount()

Number of group admins

Return: int

function blockListSize#

inline int blockListSize()

Blacklisted user-number

Return: int

function bannedListSize#

inline int bannedListSize()

Banned user-number

Return: int

function sharedFilesCount#

inline int sharedFilesCount()

Shared file-number in group

Return: int

function latestAnnouncementId#

inline long latestAnnouncementId()

Latest group announcement id

Return: int64_t

function msgPushMode#

inline BMXGroup.MsgPushMode msgPushMode()

Group message notification type

Return: [MsgPushMode]

function modifyMode#

inline BMXGroup.ModifyMode modifyMode()

Group information update mode

Return: [ModifyMode]

function joinAuthMode#

inline BMXGroup.JoinAuthMode joinAuthMode()

Join approval mode

Return: [JoinAuthMode]

function inviteMode#

inline BMXGroup.InviteMode inviteMode()

Group invitation mode

Return: [InviteMode]

function msgMuteMode#

inline BMXGroup.MsgMuteMode msgMuteMode()

Group message blocking mode

Return: [MsgMuteMode]

function groupStatus#

inline BMXGroup.GroupStatus groupStatus()

state of the current group. (Normal, Destroyed)

Return: [GroupStatus]

function isMember#

inline boolean isMember()

Deprecated use roleType instead.

Return: bool

Whether the current user is a group member

function enableReadAck#

inline boolean enableReadAck()

Whether group message read receipts are enabled

Return: bool

function historyVisible#

inline boolean historyVisible()

Whether to load and display the chat history

Return: bool

function roleType#

inline BMXGroup.MemberRoleType roleType()

Type of a member role in group

Return: [MemberRoleType]

function banExpireTime#

inline long banExpireTime()

Expiration time of banning all group members

Protected Functions Documentation#

function BMXGroup#

inline BMXGroup(
    long cPtr,
    boolean cMemoryOwn
)

function finalize#

inline void finalize()

function getCPtr#

static inline long getCPtr(
    BMXGroup obj
)

Public Attributes Documentation#

variable swigCPtr#

transient long swigCPtr;

Updated on 2022-01-26 at 17:18:31 +0800