App Frameworks · IOS API REFERENCE

StateReporting

Communicate your app’s state to the system to improve diagnostic actionability.

3 types

18 callable entries

4 skipped

82% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

ReportableMetadata

protocol · iOS 27.0+

ReportableMetadataValue

enum · iOS 27.0+

StateReporter

class · iOS 27.0+

Functions and constants

method · iOS 27.0+

reportTransition

TypeScript

reportTransition(stateLabel?: (string) | null): void

Swift declaration

final func reportTransition(to stateLabel: String?, stableMetadata: StableMetadata? = nil, volatileMetadata: VolatileMetadata? = nil)

Reports a transition to a new state. A transition occurs only when `stateLabel` or `stableMetadata` changes from the current state. If both are equal to the current values, this call is a no-op. Pass `nil` for `stateLabel` to indicate that no state is currently active, clearing any previously reported state. Passing an empty string for `stateLabel` is a fatal error. Any volatile metadata from the previous state is discarded when a new transition begins. Calling this method more frequently than user interaction timescales can trigger rate limiting, causing state updates to go unlogged. - Parameters: - stateLabel: A descriptive label for the new state, which must not be empty, or `nil` to clear the active state. - stableMetadata: An optional value that identifies the state together with `stateLabel`. - volatileMetadata: An optional value providing context likely to change within this state.

get · iOS 27.0+

domain

TypeScript

get domain(): string

Swift declaration

final let domain: String

The reverse DNS-style domain name that identifies this reporter.

Skipped declarations

4 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

Never.metadataDictionary

The containing type is outside the generated SDK type index.

StateReporter.reportVolatileMetadataUpdate(_:)

This declaration needs Swift generic type arguments. (no canonical witness for VolatileMetadata)

StateReporter.reporter(for:stableMetadata:volatileMetadata:)

The containing type needs Swift generic type arguments. (no canonical witness for StableMetadata, VolatileMetadata)

protocol implementation ReportableMetadata

non-method protocol requirement