Contents

reportVolatileMetadataUpdate(_:)

Updates the volatile metadata within the current state without beginning a new transition.

Declaration

final func reportVolatileMetadataUpdate(_ updatedMetadata: VolatileMetadata?)

Parameters

  • updatedMetadata:

    The updated volatile metadata, or nil to clear volatile context without ending the current state.

Mentioned in

Discussion

Use this method to update rapidly-changing data — such as a progress value or a running count — while staying within the same state. If no state is currently active, this call is a no-op. Calling this method more frequently than user interaction timescales can trigger rate limiting, causing updates to go unlogged.