Skip to content

//workflow/com.squareup.workflow1.ui.container/AlertOverlay

AlertOverlay

[jvm] @WorkflowUiExperimentalApi()

data class AlertOverlay(buttons: Map<AlertOverlay.Button, String>, message: String, title: String, cancelable: Boolean, onEvent: (AlertOverlay.Event) -> Unit) : Overlay

Models a typical “You sure about that?” alert box.

UI kits are expected to provide handling for this class by default.

Constructors

AlertOverlay [jvm] fun AlertOverlay(buttons: Map<AlertOverlay.Button, String> = emptyMap(), message: String = “”, title: String = “”, cancelable: Boolean = true, onEvent: (AlertOverlay.Event) -> Unit)

Types

Name Summary
Button [jvm]
Content
enum Button : Enum<AlertOverlay.Button>


Event [jvm]
Content
sealed class Event


Functions

Name Summary
equals [jvm]
Content
open operator override fun equals(other: Any?): Boolean


hashCode [jvm]
Content
open override fun hashCode(): Int


Properties

Name Summary
buttons [jvm] val buttons: Map<AlertOverlay.Button, String>
cancelable [jvm] val cancelable: Boolean = true
message [jvm] val message: String
onEvent [jvm] val onEvent: (AlertOverlay.Event) -> Unit
title [jvm] val title: String