BMXGroup Class Reference#

Inherits from BMXBaseObject :
NSObject
Declared in floo_proxy.h

Overview#

@interface 群组

Instance Methods#

adminsCount#

群管理员数量

- (int)adminsCount

Return Value#

int

Declared In#

floo_proxy.h

Example:

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

avatarPath#

群头像下载后的本地路径

- (NSString *)avatarPath

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

avatarRatelUrl#

群头像Ratel服务器Url

- (NSString *)avatarRatelUrl

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

avatarThumbnailPath#

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

- (NSString *)avatarThumbnailPath

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

avatarThumbnailUrl#

群头像缩略图服务器Url

- (NSString *)avatarThumbnailUrl

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

avatarUrl#

群头像服务器Url

- (NSString *)avatarUrl

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

banExpireTime#

群组全员禁言到期时间

- (long long)banExpireTime

Return Value#

long long

Declared In#

floo_proxy.h

Example:

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

bannedListSize#

禁言数量

- (int)bannedListSize

Return Value#

int

Declared In#

floo_proxy.h

Example:

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

blockListSize#

黑名单数量

- (int)blockListSize

Return Value#

int

Declared In#

floo_proxy.h

Example:

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

capacity#

最大人数

- (int)capacity

Return Value#

int

Declared In#

floo_proxy.h

Example:

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

createTime#

群创建时间

- (long long)createTime

Return Value#

long long

Declared In#

floo_proxy.h

Example:

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

dealloc#

- (void)dealloc

Example:

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

description#

群描述

- (NSString *)description

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

enableReadAck#

是否开启群消息已读功能

- (BOOL)enableReadAck

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

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

extension#

群扩展信息

- (NSString *)extension

Return Value#

JSON(std::string)

Declared In#

floo_proxy.h

Example:

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

groupId#

群Id

- (long long)groupId

Return Value#

long long

Declared In#

floo_proxy.h

Example:

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

groupStatus#

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

- (BMXGroup_GroupStatus)groupStatus

Return Value#

BMXGroup_GroupStatus

Declared In#

floo_proxy.h

Example:

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

groupType#

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

- (BMXGroup_GroupType)groupType

Return Value#

BMXGroup_GroupType

Declared In#

floo_proxy.h

Example:

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

historyVisible#

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

- (BOOL)historyVisible

Return Value#

BOOL

Declared In#

floo_proxy.h

Example:

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

inviteMode#

入群邀请模式

- (BMXGroup_InviteMode)inviteMode

Return Value#

BMXGroup_InviteMode

Declared In#

floo_proxy.h

Example:

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

isMember#

当前用户是否是群成员

- (BOOL)isMember

Return Value#

BOOL

Discussion#

Deprecated use roleType instead.

Declared In#

floo_proxy.h

Example:

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

joinAuthMode#

入群审批模式

- (BMXGroup_JoinAuthMode)joinAuthMode

Return Value#

BMXGroup_JoinAuthMode

Declared In#

floo_proxy.h

Example:

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

latestAnnouncementId#

Return Value#

long long

Declared In#

floo_proxy.h

Example:

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

membersCount#

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

- (int)membersCount

Return Value#

int

Declared In#

floo_proxy.h

Example:

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

modifyMode#

群信息修改模式

- (BMXGroup_ModifyMode)modifyMode

Return Value#

BMXGroup_ModifyMode

Declared In#

floo_proxy.h

Example:

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

msgMuteMode#

群消息屏蔽模式

- (BMXGroup_MsgMuteMode)msgMuteMode

Return Value#

BMXGroup_MsgMuteMode

Declared In#

floo_proxy.h

Example:

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

msgPushMode#

群消息通知类型

- (BMXGroup_MsgPushMode)msgPushMode

Return Value#

MsgPushMode

Declared In#

floo_proxy.h

Example:

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

myNickname#

在群里的昵称

- (NSString *)myNickname

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

name#

群名称

- (NSString *)name

Return Value#

NSString

Declared In#

floo_proxy.h

Example:

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

ownerId#

群Owner

- (long long)ownerId

Return Value#

long long

Declared In#

floo_proxy.h

Example:

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

roleType#

成员在群组内的角色类型

- (BMXGroup_MemberRoleType)roleType

Return Value#

BMXGroup_MemberRoleType

Declared In#

floo_proxy.h

Example:

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

sharedFilesCount#

群共享文件数量

- (int)sharedFilesCount

Return Value#

int

Declared In#

floo_proxy.h

Example:

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