---
title: IndexedEntity
framework: appintents
role: symbol
role_heading: Protocol
path: appintents/indexedentity
---

# IndexedEntity

An interface that allows you to include an entity in your app’s Spotlight index.

## Declaration

```swift
protocol IndexedEntity : AppEntity
```

## Mentioned in

Making app entities available in Spotlight Defining app entities for your custom data types

## Overview

Overview Adopt this protocol in app entities you want to include in your app’s Spotlight index. Adding entities to Spotlight makes them discoverable by Apple Intelligence, and also serves as the first step in letting Spotlight launch your app and display items that appear in search results. Use the properties of this protocol to configure additional Spotlight metadata to accompany your app entity in the index. For more information about adding entities to your app’s Spotlight index, see Making app entities available in Spotlight.

## Topics

### Specifying entity-related attributes

- [attributeSet](appintents/indexedentity/attributeset.md)
- [defaultAttributeSet](appintents/indexedentity/defaultattributeset.md)

### Hiding an entity from search results

- [hideInSpotlight](appintents/indexedentity/hideinspotlight.md)

## Relationships

### Inherits From

- [AppEntity](appintents/appentity.md)
- [AppValue](appintents/appvalue.md)
- [CustomLocalizedStringResourceConvertible](foundation/customlocalizedstringresourceconvertible.md)
- [DisplayRepresentable](appintents/displayrepresentable.md)
- [Identifiable](swift/identifiable.md)
- [InstanceDisplayRepresentable](appintents/instancedisplayrepresentable.md)
- [PersistentlyIdentifiable](appintents/persistentlyidentifiable.md)
- [Sendable](swift/sendable.md)
- [SendableMetatype](swift/sendablemetatype.md)
- [TypeDisplayRepresentable](appintents/typedisplayrepresentable.md)

## See Also

### App entity types

- [AppEntity](appintents/appentity.md)
- [FileEntity](appintents/fileentity.md)
- [SyncableEntity](appintents/syncableentity.md)
- [TransientAppEntity](appintents/transientappentity.md)
- [UniqueAppEntity](appintents/uniqueappentity.md)
- [OwnershipProvidingEntity](appintents/ownershipprovidingentity.md)
- [UnionValue()](appintents/unionvalue().md)
- [AppUnionValue](appintents/appunionvalue.md)
- [AppUnionValueCasesProviding](appintents/appunionvaluecasesproviding.md)