im::floo::floolib::BMXGroup#

群组

Inherits from BMXBaseObject

Public Classes#

Public Functions#

Protected Functions#

Public Attributes#

Public Functions Documentation#

function BMXGroup#

inline BMXGroup()

Example:

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

function delete#

inline synchronized void delete()

Example:

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

function groupId#

inline long groupId()

群Id

Return: int64_t

Example:

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

function groupType#

inline BMXGroup.GroupType groupType()

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

Return: [GroupType]

Example:

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

function myNickname#

inline String myNickname()

在群里的昵称

Return: std::string

Example:

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

function name#

inline String name()

群名称

Return: std::string

Example:

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

function description#

inline String description()

群描述

Return: std::string

Example:

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

function avatarRatelUrl#

inline String avatarRatelUrl()

群头像ratel地址

Return: std::string

Example:

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

function avatarUrl#

inline String avatarUrl()

群头像

Return: std::string

Example:

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

function avatarPath#

inline String avatarPath()

群头像下载后的本地路径

Return: std::string

Example:

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

function avatarThumbnailUrl#

inline String avatarThumbnailUrl()

群头像缩略图地址

Return: std::string

Example:

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

function avatarThumbnailPath#

inline String avatarThumbnailPath()

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

Return: std::string

Example:

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

function createTime#

inline long createTime()

群创建时间

Return: int64_t

Example:

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

function extension#

inline String extension()

群扩展信息

Return: JSON(std::string)

Example:

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

function ownerId#

inline long ownerId()

群Owner

Return: int64_t

Example:

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

function capacity#

inline int capacity()

最大人数

Return: int

Example:

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

function membersCount#

inline int membersCount()

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

Return: int

Example:

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

function adminsCount#

inline int adminsCount()

群管理员数量

Return: int

Example:

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

function blockListSize#

inline int blockListSize()

黑名单数量

Return: int

Example:

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

function bannedListSize#

inline int bannedListSize()

禁言数量

Return: int

Example:

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

function sharedFilesCount#

inline int sharedFilesCount()

群共享文件数量

Return: int

Example:

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

function latestAnnouncementId#

inline long latestAnnouncementId()

最新群公告id

Return: int64_t

Example:

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

function msgPushMode#

inline BMXGroup.MsgPushMode msgPushMode()

群消息通知类型

Return: [MsgPushMode]

Example:

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

function modifyMode#

inline BMXGroup.ModifyMode modifyMode()

群信息修改模式

Return: [ModifyMode]

Example:

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

function joinAuthMode#

inline BMXGroup.JoinAuthMode joinAuthMode()

入群审批模式

Return: [JoinAuthMode]

Example:

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

function inviteMode#

inline BMXGroup.InviteMode inviteMode()

入群邀请模式

Return: [InviteMode]

Example:

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

function msgMuteMode#

inline BMXGroup.MsgMuteMode msgMuteMode()

群消息屏蔽模式

Return: [MsgMuteMode]

Example:

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

function groupStatus#

inline BMXGroup.GroupStatus groupStatus()

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

Return: [GroupStatus]

Example:

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

function isMember#

inline boolean isMember()

Deprecated use roleType instead.

Return: bool

当前用户是否是群成员

Example:

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

function enableReadAck#

inline boolean enableReadAck()

是否开启群消息已读功能

Return: bool

Example:

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

function historyVisible#

inline boolean historyVisible()

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

Return: bool

Example:

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

function roleType#

inline BMXGroup.MemberRoleType roleType()

成员在群组内的角色类型

Return: [MemberRoleType]

Example:

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

function banExpireTime#

inline long banExpireTime()

群组全员禁言到期时间

Protected Functions Documentation#

Example:

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

function BMXGroup#

inline BMXGroup(
    long cPtr,
    boolean cMemoryOwn
)

Example:

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

function finalize#

inline void finalize()

Example:

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

function getCPtr#

static inline long getCPtr(
    BMXGroup obj
)

Public Attributes Documentation#

variable swigCPtr#

transient long swigCPtr;

Example:

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

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