<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macCatalyst: -",
    "macOS: 27.0.0 -",
    "tvOS: 27.0.0 -",
    "visionOS: 27.0.0 -",
    "watchOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "StateReporting",
  "identifier" : "/documentation/StateReporting/ReportableMetadata",
  "metadataVersion" : "0.1.0",
  "role" : "Protocol",
  "symbol" : {
    "kind" : "Protocol",
    "modules" : [
      "StateReporting"
    ],
    "preciseIdentifier" : "s:14StateReporting18ReportableMetadataP"
  },
  "title" : "ReportableMetadata"
}
-->

# ReportableMetadata

A protocol for types that can supply their metadata as a dictionary of reportable values.

```
protocol ReportableMetadata
```

## Overview

Adopt `ReportableMetadata` to pass stable or volatile metadata to [`StateReporter`](/documentation/StateReporting/StateReporter). The single
required property, [`metadataDictionary`](/documentation/StateReporting/ReportableMetadata/metadataDictionary), maps string keys to [`ReportableMetadataValue`](/documentation/StateReporting/ReportableMetadataValue) cases.
Use the [`ReportableMetadata()`](/documentation/StateReporting/ReportableMetadata()) macro to synthesize the conformance automatically from stored
properties, rather than implementing it by hand.

## Topics

### Instance Properties

[`var metadataDictionary: [String : ReportableMetadataValue]`](/documentation/StateReporting/ReportableMetadata/metadataDictionary)

A dictionary mapping string keys to reportable values that describes the current metadata.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)