matrix-sdk-android/org.matrix.android.sdk.api.session.room.members/MembershipService

MembershipService

interface MembershipService

This interface defines methods to handling membership. It's implemented at the room level.

Functions

areAllMembersLoaded

abstract suspend fun areAllMembersLoaded(): Boolean

All the room members can be not loaded, for instance after an initial sync. All the members will be loaded when calling loadRoomMembersIfNeeded, or when sending an encrypted event to the room. The fun let the app know if all the members have been loaded for this room.

areAllMembersLoadedLive

abstract fun areAllMembersLoadedLive(): LiveData<Boolean>

Live version for areAllMembersLoaded.

abstract suspend fun ban(userId: String, reason: String? = null)

Ban a user from the room.

getNumberOfJoinedMembers

abstract fun getNumberOfJoinedMembers(): Int

abstract fun getRoomMember(userId: String): RoomMemberSummary?

Return the roomMember with userId or null.

abstract fun getRoomMembers(queryParams: RoomMemberQueryParams): List<RoomMemberSummary>

Return all the roomMembers of the room with params.

getRoomMembersLive

abstract fun getRoomMembersLive(queryParams: RoomMemberQueryParams): LiveData<List<RoomMemberSummary>>

Return all the roomMembers of the room filtered by memberships.

abstract suspend fun invite(userId: String, reason: String? = null)

Invite a user in the room.

abstract suspend fun invite3pid(threePid: ThreePid)

Invite a user with email or phone number in the room.

~~open~~ ~~suspend~~ ~~fun~~ ~~kick~~(userId: String, reason: String? = null)

loadRoomMembersIfNeeded

abstract suspend fun loadRoomMembersIfNeeded()

This methods load all room members if it was done yet.

abstract suspend fun remove(userId: String, reason: String? = null)

Remove a user from the room.

abstract suspend fun unban(userId: String, reason: String? = null)

Unban a user from the room.