im::floo::floolib::BMXGroup#

Group

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

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

Type of the current group (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()

Group member nickname of mine

Return: std::string

Example:

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

function name#

inline String name()

Group name

Return: std::string

Example:

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

function description#

inline String description()

Group 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 address of group avatar

Return: std::string

Example:

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

function avatarUrl#

inline String avatarUrl()

Group avatar

Return: std::string

Example:

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

function avatarPath#

inline String avatarPath()

Local path of downloaded group avatar

Return: std::string

Example:

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

function avatarThumbnailUrl#

inline String avatarThumbnailUrl()

Group avatar thumbnail address

Return: std::string

Example:

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

function avatarThumbnailPath#

inline String avatarThumbnailPath()

Local path of downloaded group avatar thumbnail

Return: std::string

Example:

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

function createTime#

inline long createTime()

Group creation time

Return: int64_t

Example:

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

function extension#

inline String extension()

Group extension information

Return: JSON(std::string)

Example:

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

function ownerId#

inline long ownerId()

Group Owner

Return: int64_t

Example:

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

function capacity#

inline int capacity()

Maximum number of group members

Return: int

Example:

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

function membersCount#

inline int membersCount()

Number of group members, including Owner, Admins and Members

Return: int

Example:

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

function adminsCount#

inline int adminsCount()

Number of group admins

Return: int

Example:

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

function blockListSize#

inline int blockListSize()

Blacklisted user-number

Return: int

Example:

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

function bannedListSize#

inline int bannedListSize()

Banned user-number

Return: int

Example:

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

function sharedFilesCount#

inline int sharedFilesCount()

Shared file-number in group

Return: int

Example:

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

function latestAnnouncementId#

inline long latestAnnouncementId()

Latest group announcement 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()

Group message notification type

Return: [MsgPushMode]

Example:

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

function modifyMode#

inline BMXGroup.ModifyMode modifyMode()

Group information update mode

Return: [ModifyMode]

Example:

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

function joinAuthMode#

inline BMXGroup.JoinAuthMode joinAuthMode()

Join approval mode

Return: [JoinAuthMode]

Example:

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

function inviteMode#

inline BMXGroup.InviteMode inviteMode()

Group invitation mode

Return: [InviteMode]

Example:

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

function msgMuteMode#

inline BMXGroup.MsgMuteMode msgMuteMode()

Group message blocking mode

Return: [MsgMuteMode]

Example:

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

function groupStatus#

inline BMXGroup.GroupStatus groupStatus()

state of the current group. (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

Whether the current user is a group member

Example:

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

function enableReadAck#

inline boolean enableReadAck()

Whether group message read receipts are enabled

Return: bool

Example:

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

function historyVisible#

inline boolean historyVisible()

Whether to load and display the chat history

Return: bool

Example:

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

function roleType#

inline BMXGroup.MemberRoleType roleType()

Type of a member role in group

Return: [MemberRoleType]

Example:

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

function banExpireTime#

inline long banExpireTime()

Expiration time of banning all group members

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