StopRefreshingEventSchema

@Serializable
@SerialName(value = "StopRefreshing")
data class StopRefreshingEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val tileId: String) : EventSchema

Stops the loading indicator of the PullToRefresh tile identified by tileId, by dispatching a PullToRefreshTileEvents.StopRefreshing to it. The tile never hides the spinner on its own, so this event has to close every refresh flow — on the success branch and on the failure branch alike.

incomingData consumed: not used.

Triggers fired:

  • OnSuccessEventTrigger — when the signal reached the tile. No data is passed downstream.

  • OnFailureEventTrigger — when no tile with tileId is currently mounted; the Throwable is passed as incomingData.

Constructors

Link copied to clipboard
constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, tileId: String)

Properties

Link copied to clipboard
@SerialName(value = "events")
open override val events: SerializableImmutableList<EventSchema>?

This event's own children — each declaring, via its own trigger, which of this event's outgoing triggers runs it. null when this event declares no children.

Link copied to clipboard
@SerialName(value = "id")
open override val id: String

Unique identifier — how TriggerEvent/UpdateEvents address this event by id. Defaults to a random id when omitted from the DSL.

Link copied to clipboard
@SerialName(value = "tileId")
val tileId: String
Link copied to clipboard
@SerialName(value = "trigger")
open override val trigger: EventTrigger

The condition that must occur for this event to run — matched by structural equality (data class/data object equality) against whatever trigger value fired, never by any kind of subscription or listener registry.