<!--
{
  "availability" : [
    "iOS: 27.0.0 -",
    "iPadOS: 27.0.0 -",
    "macCatalyst: -",
    "macOS: 27.0.0 -",
    "visionOS: 27.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "AppIntents",
  "identifier" : "/documentation/AppIntents/AppSchema/MapsEntity/navigationSession",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Property",
  "symbol" : {
    "kind" : "Instance Property",
    "modules" : [
      "App Intents",
      "AppIntents"
    ],
    "preciseIdentifier" : "s:10AppIntents0A6SchemaV10MapsEntityPAAE17navigationSessionQrvp"
  },
  "title" : "navigationSession"
}
-->

# navigationSession

An entity schema for a navigation session.

```
var navigationSession: some AppSchemaEntity { get }
```

## Discussion

To make your app’s content available to Apple Intelligence,
conform your [`AppEntity`](/documentation/AppIntents/AppEntity) to a schema that describes your content to the system.
If your app’s functionality aligns with the `maps` domain
and its content matches the `navigationSession` schema,
you can generate the properties and protocol conformance the schema requires
for your app entity implementation
with the `@AppEntity( .maps.navigationSession)` Swift macro.
To make your app work with Siri,
see <doc://com.apple.documentation/documentation/AppIntents/apple-intelligence-and-siri-ai>.

The following example shows an app entity that conforms to the `navigationSession` schema:

```swift
@AppEntity(schema: .maps.navigationSession)
struct MapsNavigationSessionEntity: UniqueEntity {
    // MARK: Static

    static let defaultQuery = MapsNavigationSessionEntityQuery()

    // MARK: Properties

    let id: <#Identifiable.ID#>

    var estimatedArrivalDate: Date
    var waypoints: [<#MapsLocation#>]
    var transportationType: <#MapsTransportTypeEnum#>
    var preferences: [<#MapsNavigationPreferencesEnum#>]

    var displayRepresentation: DisplayRepresentation {
        <#DisplayRepresentation#>
    }

    // MARK: Query

    struct MapsNavigationSessionEntityQuery: EntityQuery {
        func entities(for identifiers: [MapsNavigationSessionEntity.ID]) async throws -> [MapsNavigationSessionEntity] {
            <#code#>
        }
    }
}
```

Define a `@UnionValue` enumeration for the `waypoints` property, as in the following example,
by typing the first few characters of `maps_location` in Xcode and selecting it from the code-completion suggestions.

```swift
@UnionValue
enum MapsLocation {
    case place(<#MapsPlaceEntity#>)
    case currentLocation(<#MapsCurrentLocationEntity#>)
}
```

> Tip: Keep the cases that your app supports and remove the rest.

The schema supports the following system experiences:

- Siri
- Shortcuts

For more information about the App Intents framework and the experiences it supports,
see <doc://com.apple.documentation/documentation/AppIntents/getting-started-with-the-app-intents-framework>.

---

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)