matrix-sdk-android/org.matrix.android.sdk.api.session.room.state/StateService

StateService

interface StateService
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun deleteAvatar()
Content copied to clipboard

Delete the avatar of the room.

Link copied to clipboard
abstract fun getStateEvent(eventType: String, stateKey: QueryStateEventValue): Event?
Content copied to clipboard

Get a state event of the room.

Link copied to clipboard
abstract fun getStateEventLive(eventType: String, stateKey: QueryStateEventValue): LiveData<Optional<Event>>
Content copied to clipboard

Get a live state event of the room.

Link copied to clipboard
abstract fun getStateEvents(eventTypes: Set<String>, stateKey: QueryStateEventValue): List<Event>
Content copied to clipboard

Get state events of the room.

Link copied to clipboard
abstract fun getStateEventsLive(eventTypes: Set<String>, stateKey: QueryStateEventValue): LiveData<List<Event>>
Content copied to clipboard

Get live state events of the room.

Link copied to clipboard
abstract suspend fun sendStateEvent(    eventType: String,     stateKey: String,     body: JsonDict): String
Content copied to clipboard

Send a state event to the room.

Link copied to clipboard
abstract suspend fun setJoinRuleInviteOnly()
Content copied to clipboard
Link copied to clipboard
abstract suspend fun setJoinRulePublic()
Content copied to clipboard
Link copied to clipboard
abstract suspend fun setJoinRuleRestricted(allowList: List<String>)
Content copied to clipboard
Link copied to clipboard
abstract suspend fun updateAvatar(avatarUri: Uri, fileName: String)
Content copied to clipboard

Update the avatar of the room.

Link copied to clipboard
abstract suspend fun updateCanonicalAlias(alias: String?, altAliases: List<String>)
Content copied to clipboard

Update the canonical alias of the room.

Link copied to clipboard
abstract suspend fun updateHistoryReadability(readability: RoomHistoryVisibility)
Content copied to clipboard

Update the history readability of the room.

Link copied to clipboard
abstract suspend fun updateJoinRule(    joinRules: RoomJoinRules?,     guestAccess: GuestAccess?,     allowList: List<RoomJoinRulesAllowEntry>? = null)
Content copied to clipboard

Update the join rule and/or the guest access.

Link copied to clipboard
abstract suspend fun updateName(name: String)
Content copied to clipboard

Update the name of the room.

Link copied to clipboard
abstract suspend fun updateTopic(topic: String)
Content copied to clipboard

Update the topic of the room.

Extensions

Link copied to clipboard
fun StateService.isPublic(): Boolean
Content copied to clipboard

Return true if a room can be joined by anyone (RoomJoinRules.PUBLIC).