<!--
{
  "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" : "AppIntents",
  "identifier" : "/documentation/AppIntents/RelevantEntities",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "App Intents"
    ],
    "preciseIdentifier" : "s:10AppIntents16RelevantEntitiesV"
  },
  "title" : "RelevantEntities"
}
-->

# RelevantEntities

A type you use to donate your app’s songs, albums, artists, and other media
items to play during workouts.

```
struct RelevantEntities
```

## Overview

Use the shared `RelevantEntities` object to donate songs, albums, artists,
playlists, radio stations, podcasts, or other media-related content to the system.
Base your donations on whatever criteria makes sense for your app. For example, you
might donate songs that someone listens to frequently or donate new items that you
think someone might like based on their tastes. The system uses your donations to
offer suggestions for content someone can play during a workout or other scenario.

When you donate media items using this type, provide all the items at once using the
`RelevantEntities/updateSuggestedEntities(_:)` method. Apps provide only one set
of suggestions at a time, and those suggestions remain active until you clear them. Each
time you call the `RelevantEntities/updateSuggestedEntities(_:)` method, the system
replaces your app’s previous suggestions with the new set. If you don’t have any suggestions,
you can specify an empty array when calling the method. If someone doesn’t launch your app,
the system automatically expires your app’s suggestions after approximately four weeks.

## Topics

### Getting the shared type

[`shared`](/documentation/AppIntents/RelevantEntities/shared)

The shared instance of this class.

### Donating entities

[`updateEntities(_:for:)`](/documentation/AppIntents/RelevantEntities/updateEntities(_:for:))

Donates suggested entities for a single context.

### Removing the current donations

[`removeAllEntities()`](/documentation/AppIntents/RelevantEntities/removeAllEntities())

Removes all suggested entities across all contexts.

[`removeAllEntities(for:)`](/documentation/AppIntents/RelevantEntities/removeAllEntities(for:))

Removes all donated entities for the given context.

[`removeEntities(_:)`](/documentation/AppIntents/RelevantEntities/removeEntities(_:))

Removes the specified entities across all contexts.

[`removeEntities(_:from:)`](/documentation/AppIntents/RelevantEntities/removeEntities(_:from:))

Removes specific entities from the given context.


---

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)