matrix-sdk-android/org.matrix.android.sdk.api.session.space/SpaceService

SpaceService

interface SpaceService
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun createSpace(params: CreateSpaceParams): String
Content copied to clipboard

Create a space asynchronously.

abstract suspend fun createSpace(    name: String,     topic: String?,     avatarUri: Uri?,     isPublic: Boolean,     roomAliasLocalPart: String? = null): String
Content copied to clipboard

Just a shortcut for space creation for ease of use.

Link copied to clipboard
abstract suspend fun getRootSpaceSummaries(): List<RoomSummary>
Content copied to clipboard

Get the root spaces, i.e. all the spaces which do not have a parent space.

Link copied to clipboard
abstract fun getSpace(spaceId: String): Space?
Content copied to clipboard

Get a space from a spaceId.

Link copied to clipboard
abstract fun getSpaceSummaries(spaceSummaryQueryParams: SpaceSummaryQueryParams, sortOrder: RoomSortOrder = RoomSortOrder.NONE): List<RoomSummary>
Content copied to clipboard
Link copied to clipboard
abstract fun getSpaceSummariesLive(queryParams: SpaceSummaryQueryParams, sortOrder: RoomSortOrder = RoomSortOrder.NONE): LiveData<List<RoomSummary>>
Content copied to clipboard

Get a live list of space summaries. This list is refreshed as soon as the data changes.

Link copied to clipboard
abstract suspend fun joinSpace(    spaceIdOrAlias: String,     reason: String? = null,     viaServers: List<String> = emptyList()): JoinSpaceResult
Content copied to clipboard
Link copied to clipboard
abstract suspend fun leaveSpace(spaceId: String, reason: String? = null)
Content copied to clipboard

Leave the space, or reject an invitation.

Link copied to clipboard
abstract suspend fun peekSpace(spaceId: String): SpacePeekResult
Content copied to clipboard

Try to resolve (peek) rooms and subspace in this space. Use this call get preview of children of this space, particularly useful to get a preview of rooms that you did not join yet.

Link copied to clipboard
abstract suspend fun querySpaceChildren(    spaceId: String,     suggestedOnly: Boolean? = null,     limit: Int? = null,     from: String? = null,     knownStateList: List<SpaceChildSummaryEvent>? = null): SpaceHierarchyData
Content copied to clipboard

Get's information of a space by querying the server.

Link copied to clipboard
abstract suspend fun rejectInvite(spaceId: String, reason: String?)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun removeSpaceParent(childRoomId: String, parentSpaceId: String)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun setSpaceParent(    childRoomId: String,     parentSpaceId: String,     canonical: Boolean,     viaServers: List<String>)
Content copied to clipboard

Let this room declare that it has a parent.