events

type Choice struct {
	Value any
	// Media names the local game the choice stands for, nil when it is not
	// a game. It is public and copied into the event.
	Media *models.UIChoiceMedia
	Label string
	// Current marks the choice standing for what is open now. Only host
	// widgets show it; it is not part of the public event.
	Current bool
}

type Handle struct {
	Results <-chan Result
	// Shown receives, once, the time the event was first put on screen: by a
	// client reporting it through Service.Shown or by the host renderer
	// presenting it. It is never closed.
	Shown <-chan time.Time
	ID    string
	// HandOffHold is the least time the event was kept open for a client to
	// start and draw it when HandedOff is set; zero when no wait was asked.
	HandOffHold    time.Duration
	MinimumDisplay time.Duration
	// HandedOff reports that the host renderer left the event to API clients.
	HandedOff bool
	// contains filtered or unexported fields
}

type HandoffRenderer interface {
	HandOffUI(ctx context.Context, event *models.UIEvent) (handled bool, minOpen time.Duration)
}

type KindRenderer interface {
	RendersUIKind(models.UIEventKind) bool
}

type OverMediaRenderer interface {
	RendersOverMedia() bool
}

type Publisher func(models.UIStateResponse)

type Renderer interface {
	PresentUI(context.Context, *models.UIEvent) (closeFn func() error, err error)
}

type Request struct {
	Kind    models.UIEventKind
	Title   string
	Message string
	Choices []Choice
	// SelectedChoice is picker choice index. Zero selects first choice; use -1
	// explicitly when no choice should be preselected.
	SelectedChoice int
	Timeout        time.Duration
	Dismissible    bool
	// SkipHostRenderer keeps the request available to API clients without
	// presenting it through the platform renderer.
	SkipHostRenderer bool
}

type Result struct {
	Value      any
	Resolution models.UIResolution
}

type Service struct {
	// contains filtered or unexported fields
}

type TimedRenderer interface {
	MinimumUIDisplay(models.UIEventKind) time.Duration
}

type Update struct {
	Title       *string
	Message     *string
	Timeout     *time.Duration
	Dismissible *bool
}

type UpdatingRenderer interface {
	UpdateUI(context.Context, *models.UIEvent) error
}