receivedInvitations

abstract val receivedInvitations: StateFlow<List<Invitation>>

A reactive hot flow of invitations received by the user.

This property provides a continuously updated list of Invitation objects, representing the invitations the user has received from other Rainbow users. Each Invitation contains details such as its ID, sender, and status.

Behavior:

  • The receivedInvitations StateFlow automatically reflects changes in real-time whenever new invitations are received or existing invitations are updated.

  • The flow starts once the user is authenticated and remains active until logout or application closure.

Usage:

  • This property can be observed within a coroutine scope to reactively handle updates to received invitations.

  • Use it to keep your UI or other application components in sync with the latest state of received invitations.

Return

A StateFlow emitting a list of Invitation objects, updated as the user receives new invitations or existing invitations are modified.