onboarding/edu.stanford.spezi.modules.onboarding.invitation

Package-level declarations

The invitation package manages the invitation process, allowing users to join an app. The InvitationCodeScreenData provides all necessary data for the view like the title, the description and the redeem Action. It is provided via a implementation of the InvitationCodeScreen interface. The Screen can be used anywhere after providing this interface.

Example implementation:

class EngageInvitationCodeRepository @Inject constructor(
    private val navigator: Navigator,
) : InvitationCodeRepository {

    override fun getScreenData(): InvitationCodeScreenData {
        return InvitationCodeScreenData(
            title = "Invitation Code",
            description = "Please enter your invitation code to join the ENGAGE-HF study.",
            redeemAction = { navigator.navigateTo(AppNavigationEvent.AppScreen(true)) },
        )
    }
}

Types

Action

sealed interface Action

InvitationCodeRepository

interface InvitationCodeRepository

InvitationCodeScreenTestIdentifier

enum InvitationCodeScreenTestIdentifier : Enum<InvitationCodeScreenTestIdentifier>

InvitationCodeUiState

data class InvitationCodeUiState(val description: StringResource = StringResource(""), val invitationCode: String = "", val error: StringResource? = null)

InvitationCodeViewData

data class InvitationCodeViewData(val description: StringResource, val redeemAction: () -> Unit)

InvitationCodeViewModel

class InvitationCodeViewModel : ViewModel

Functions

InvitationCodeView

@Composable

fun InvitationCodeView()