<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macCatalyst: 27.0.0 -",
    "macOS: 27.0.0 -",
    "visionOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AppIntentsTesting",
  "identifier" : "/documentation/AppIntentsTesting/AppEntityDefinition/spotlightQuery(_:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "App Intents Testing",
      "AppIntentsTesting"
    ],
    "preciseIdentifier" : "s:17AppIntentsTesting0A16EntityDefinitionV14spotlightQueryySayAA03AnyaD0VGSSSgYaKF"
  },
  "title" : "spotlightQuery(_:)"
}
-->

# spotlightQuery(_:)

Performs a Spotlight search query for entities of this type.

```
func spotlightQuery(_ userQuery: String? = nil) async throws -> [AnyAppEntity]
```

## Parameters

`userQuery`

The search query string. If `nil`, returns all indexed entities.

## Return Value

An array of `AnyAppEntity` instances that match the search criteria.

## Discussion> Throws: An error if the spotlight query fails.

---

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)