libcore/io.mimi.sdk.core.controller/GroupController

GroupController

interface GroupController

An interface defining access to groups.

Important: This interface is not stable for inheritance, as new methods may be added, but is stable for use.

Since

6.1.0

Properties

abstract val activeGroup: MimiObservable<MimiGroup?>

A MimiObservable exposing the current MimiGroup.

abstract val mimiGroups: MimiObservable<AsyncState<List<MimiGroup>>>

All MimiGroups owned by UserController.mimiUser

Functions

abstract suspend fun activateGroup(mimiGroup: MimiGroup)

Activates a MimiGroup , deactivating and replacing any existing activated group

activateMemberInGroup

abstract suspend fun activateMemberInGroup(group: MimiGroup, member: MimiGroupMember): MimiGroup

Activates a MimiGroupMember of a MimiGroup, updates GroupController.mimiGroups and if necessary GroupController.activeGroup

addMemberToGroup

abstract suspend fun addMemberToGroup(group: MimiGroup, name: String, yearOfBirth: Int): MimiGroupMember

Adds the MimiGroupMember to a MimiGroup, updates GroupController.mimiGroups and if necessary GroupController.activeGroup

abstract suspend fun createGroup(): MimiGroup

Creates a new group in the backend and updates the GroupController.mimiGroups

deactivateGroup

abstract suspend fun deactivateGroup()

Deactivates the currently active MimiGroup If no group is active nothing will change.

deactivateMemberInGroup

abstract suspend fun deactivateMemberInGroup(group: MimiGroup, member: MimiGroupMember): MimiGroup

Deactivates a MimiGroupMember of a MimiGroup, updates GroupController.mimiGroups and if necessary GroupController.activeGroup

abstract suspend fun deleteGroup(group: MimiGroup)

Deletes the mimiGroup from the backend, deactivates it if it was active and updates the GroupController.mimiGroups

deleteMemberFromGroup

abstract suspend fun deleteMemberFromGroup(group: MimiGroup, member: MimiGroupMember)

Removes the MimiGroupMember from a MimiGroup, updates GroupController.mimiGroups and if necessary GroupController.activeGroup