<!--
{
  "availability" : [
    "iOS: 14.0.0 -",
    "iPadOS: 14.0.0 -",
    "macCatalyst: 14.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 7.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "SiriKit",
  "identifier" : "/documentation/Intents/INShortcutAvailabilityOptions",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Intents"
    ],
    "preciseIdentifier" : "c:@E@INShortcutAvailabilityOptions"
  },
  "title" : "INShortcutAvailabilityOptions"
}
-->

# INShortcutAvailabilityOptions

Defined contexts in which an intent or activity might be relevant to a user.

```
struct INShortcutAvailabilityOptions
```

## Overview

The system uses the set of availability options in a donated shortcut to provide the user with shortcuts relevant in a particular context or circumstance. For example, a meditation app could include an intent with [`sleepMindfulness`](/documentation/Intents/INShortcutAvailabilityOptions/sleepMindfulness) in its <doc://com.apple.documentation/documentation/Foundation/NSUserActivity/shortcutAvailability> options when calling [`setShortcutSuggestions(_:)`](/documentation/Intents/INVoiceShortcutCenter/setShortcutSuggestions(_:)). Then the Wind Down configuration screen in the Health app includes that intent in the Mindfulness category when guiding the user to set up shortcuts.

Provide accurate availability options when you suggest shortcuts to [`INVoiceShortcutCenter`](/documentation/Intents/INVoiceShortcutCenter) with [`setShortcutSuggestions(_:)`](/documentation/Intents/INVoiceShortcutCenter/setShortcutSuggestions(_:)), and when you donate shortcuts based on user actions. If none of the options apply to an intent, provide an empty <doc://com.apple.documentation/documentation/Swift/OptionSet>.

> Tip:
> Most shortcuts should specify a single activity type, but you can use an option set with more than one category if a shortcut really doesn’t fit neatly into a single category.

For more information on donating shortcuts effectively, see <doc://com.apple.documentation/documentation/SiriKit/donating-shortcuts>.

## Topics

### Providing Contexts

[`sleepMindfulness`](/documentation/Intents/INShortcutAvailabilityOptions/sleepMindfulness)

Meditation and other activities intended to facilitate mindfulness.

[`sleepJournaling`](/documentation/Intents/INShortcutAvailabilityOptions/sleepJournaling)

Writing and other daily logging activities.

[`sleepMusic`](/documentation/Intents/INShortcutAvailabilityOptions/sleepMusic)

Music suitable for falling asleep.

[`sleepPodcasts`](/documentation/Intents/INShortcutAvailabilityOptions/sleepPodcasts)

A podcast or other spoken audio.

[`sleepReading`](/documentation/Intents/INShortcutAvailabilityOptions/sleepReading)

A book or other reading material.

[`sleepWrapUpYourDay`](/documentation/Intents/INShortcutAvailabilityOptions/sleepWrapUpYourDay)

An activity in preparation for sleep such as personal grooming or reviewing the next day’s agenda.

[`sleepYogaAndStretching`](/documentation/Intents/INShortcutAvailabilityOptions/sleepYogaAndStretching)

Physical activity to prepare for sleep.

### Creating an Availability Set

[`init(rawValue:)`](/documentation/Intents/INShortcutAvailabilityOptions/init(rawValue:))

Returns the set of availability categories represented by the given value.


---

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)