im::floo::floolib::BMXGroup#
群組
Inherits from BMXBaseObject
Public Classes#
| Name | |
|---|---|
| class | Announcement 群公告 |
| class | Application 群申請 |
Public Functions#
| Name | |
|---|---|
| BMXGroup() | |
| synchronized void | delete() |
| long | groupId() 群Id |
| BMXGroup.GroupType | groupType() 當前群組的群組類型(Private 私有群組,Public 公開群組,Chatroom 聊天室) |
| String | myNickname() 在群裡的暱稱 |
| String | name() 群名稱 |
| String | description() 群描述 |
| String | avatarRatelUrl() 群頭像ratel地址 |
| String | avatarUrl() 群頭像 |
| String | avatarPath() 群頭像下載後的本地路徑 |
| String | avatarThumbnailUrl() 群頭像縮略圖地址 |
| String | avatarThumbnailPath() 群頭像縮略圖下載後的本地路徑 |
| long | createTime() 群建立時間 |
| String | extension() 群擴展信息 |
| long | ownerId() 群Owner |
| int | capacity() 最大人數 |
| int | membersCount() 群成員數量,包含Owner,admins 和members |
| int | adminsCount() 群管理員數量 |
| int | blockListSize() 黑名單數量 |
| int | bannedListSize() 禁言數量 |
| int | sharedFilesCount() 群共享檔案數量 |
| long | latestAnnouncementId() 最新群公告id |
| BMXGroup.MsgPushMode | msgPushMode() 群訊息通知類型 |
| BMXGroup.ModifyMode | modifyMode() 群信息修改模式 |
| BMXGroup.JoinAuthMode | joinAuthMode() 入群審批模式 |
| BMXGroup.InviteMode | inviteMode() 入群邀請模式 |
| BMXGroup.MsgMuteMode | msgMuteMode() 群訊息屏蔽模式 |
| BMXGroup.GroupStatus | groupStatus() 當前群組的狀態。(Normal 正常, Destroyed 以銷燬) |
| boolean | isMember() Deprecated use roleType instead. |
| boolean | enableReadAck() 是否開啟群訊息已讀功能 |
| boolean | historyVisible() 是否可以加載顯示歷史聊天記錄 |
| BMXGroup.MemberRoleType | roleType() 成員在群組內的角色類型 |
| long | banExpireTime() 群組全員禁言到期時間 |
Protected Functions#
Public Attributes#
| Name | |
|---|---|
| transient long | swigCPtr |
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