<!--
{
  "availability" : [
    "iOS: 15.0.0 -",
    "iPadOS: 15.0.0 -",
    "macCatalyst: 15.0.0 -",
    "macOS: 12.0.0 -",
    "tvOS: 15.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "GroupActivities",
  "identifier" : "/documentation/GroupActivities/GroupActivity/metadata",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "Group Activities"
    ],
    "preciseIdentifier" : "s:15GroupActivities0A8ActivityP8metadataAA0aC8MetadataVvp"
  },
  "title" : "metadata"
}
-->

# metadata

A description of the activity, and optional image to display to the user.

```
var metadata: GroupActivityMetadata { get async }
```

## Discussion

The system accesses this property when it’s ready to invite other participants
to join the activity. Don’t access this property directly. Instead, implement
it in your custom activity types and provide descriptive information
about the current activity. For example, provide the title of the activity
and an image that illustrates the activity.

---

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)