bps-kit 1.0.1 → 1.0.3

package/templates/vault/hig-technologies/references/healthkit.md

@@ -1,120 +0,0 @@
----
-title: "HealthKit | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/healthkit
-
-# HealthKit
-
-HealthKit is the central repository for health and fitness data in iOS, iPadOS, and watchOS.
-
-![A sketch of the HealthKit icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/1ea6de75ffe8173e0253ce0b4bf27b83/technologies-HealthKit-intro%402x.png)
-
-When you support HealthKit in your app, you can ask people for permission to access and update their health information.
-
-Important
-
-If your app doesn’t provide health and fitness functionality, don’t request access to people’s private health data.
-
-For example, a nutrition app might ask for permission to retrieve people’s weight and activity data, so it can define calorie consumption goals and make dietary recommendations. In this scenario, the nutrition app could also send data — such as the calories that people log — to HealthKit, which can include the data in its global progress metrics.
-
-![A screenshot of the Health app's summary screen on iPhone, showing current data for activity, active energy, stair speed, heart rate, resting energy, and stand minutes.](https://docs-assets.developer.apple.com/published/fdb416a7e3e60d832ba22dd317fae712/health-summary%402x.png)
-
-For developer guidance, see [HealthKit](https://developer.apple.com/documentation/HealthKit).
-
-## [Privacy protection](https://developer.apple.com/design/human-interface-guidelines/healthkit#Privacy-protection)
-
-You must request permission to access people’s data, and you must take all necessary steps to protect that data. After you receive permission, it’s essential to maintain people’s trust by clearly showing them how you use their data. For developer guidance, see [Protecting user privacy](https://developer.apple.com/documentation/HealthKit/protecting-user-privacy).
-
-**Provide a coherent privacy policy.** During the app submission process, you must provide a URL to a clearly stated privacy policy, so that people can view the policy when they click the link in the App Store page for your app. For developer guidance, see [App Information > App Store Connect Help](https://help.apple.com/app-store-connect/#/dev219b53a88).
-
-**Request access to health data only when you need it.** It makes sense to request access to weight information when people log their weight, for example, but not immediately after your app launches. When your request is clearly related to the current context, you help people understand your app’s intentions. Also, people can change the permissions they grant, so your app needs to make a request every time it needs access. For developer guidance, see [`requestAuthorization(toShare:read:completion:)`](https://developer.apple.com/documentation/HealthKit/HKHealthStore/requestAuthorization\(toShare:read:completion:\)).
-
-**Clarify your app’s intent by adding descriptive messages to the standard permission screen.** People expect to see the system-provided permission screen when asked to approve access to health data. Write a few succinct sentences that explain why you need the information and how people can benefit from sharing it with your app. Avoid adding custom screens that replicate the standard permission screen’s behavior or content.
-
-![A screenshot of a Health Access screen on iPhone, which asks for permission for an app to write and read mindful minute data.](https://docs-assets.developer.apple.com/published/68014b16fae04d2ed8dfeecee91a4c39/health-access-requests%402x.png)
-
-**Manage health data sharing solely through the system’s privacy settings.** People expect to globally manage access to their health information in Settings > Privacy. Don’t confuse people by building additional screens in your app that affect the flow of health data.
-
-## [Activity rings](https://developer.apple.com/design/human-interface-guidelines/healthkit#Activity-rings)
-
-You can enhance your app’s health and wellness offerings by displaying the Activity ring element to show people’s progress toward their Move, Exercise, and Stand goals. The Activity app defines the position and color of each ring, so people are familiar with the element and understand what it means.
-
-![A screenshot of the Activity app's History screen on iPhone, which shows daily activity rings progress for June and part of July.](https://docs-assets.developer.apple.com/published/26eb6fb57c43110b544e51e0760790d5/activity-months%402x.png)
-
-**Use Activity rings for Move, Exercise, and Stand information only.** Activity rings consistently represent progress in these specific areas. Don’t attempt to replicate or modify Activity rings for other purposes or to display other types of data. Never show Move, Exercise, and Stand progress in another ring-like element.
-
-**Use Activity rings to show progress for a single person.** Never use Activity rings to represent data for more than one person, and make sure it’s obvious whose progress is shown, such as by using a label, a photo, or an avatar.
-
-**Don’t use Activity rings for ornamentation.** Activity rings provide information to people; they don’t merely embellish your app’s design. Never display Activity rings in labels or background graphics.
-
-**Don’t use Activity rings for branding.** Use Activity rings strictly to display Activity progress in your app. Never use Activity rings in your app’s icon or marketing materials.
-
-**Maintain Activity ring and background colors.** For a consistent user experience, the visual appearance of Activity rings must always be the same, regardless of the context in which they appear. Never change the look of the rings or background by using filters, changing colors, or modifying opacity. Instead, design the surrounding interface to blend with the rings. For example, enclose the rings within a circle. Always scale the rings appropriately so they don’t seem disconnected or out of place.
-
-**Maintain Activity ring margins.** An Activity ring element must include a minimum outer margin of no less than the distance between rings. Never allow other elements to crop, obstruct, or encroach upon this margin or the rings themselves. To display an Activity ring element within a circle, adjust the corner radius of the enclosing view rather than applying a circular mask.
-
-**Differentiate other ring-like elements from Activity rings.** Mixing different ring styles can lead to a visually confusing interface. If you must include other rings, use padding, lines, or labels to separate them from Activity rings. Color and scale can also help provide visual separation.
-
-**Provide app-specific information only in Activity notifications.** The system already delivers Move, Exercise, and Stand progress updates. Don’t repeat this same information, and never show an Activity ring element in your app’s notifications. It’s fine to reference Activity progress in a notification, but do so in a way that’s unique to your app and doesn’t replicate the same information provided by the system.
-
-For developer guidance, see [`HKActivityRingView`](https://developer.apple.com/documentation/HealthKitUI/HKActivityRingView).
-
-## [Apple Health icon](https://developer.apple.com/design/human-interface-guidelines/healthkit#Apple-Health-icon)
-
-The Apple Health icon shows that an app works with HealthKit and the Health app. The following guidelines help you use the icon correctly. To learn how to refer to HealthKit and the Health app in copy and UI text, see [Editorial guidelines](https://developer.apple.com/design/human-interface-guidelines/healthkit#Editorial-guidelines); to learn about using the “Works with Apple Health” badge in your marketing communications, see [Works with Apple Health](https://developer.apple.com/health-fitness/works-with-apple-health/).
-
-![A screenshot of an onboarding screen for an app named Eating Habits, which displays the Apple Health icon and text that describes how syncing health data from Eating Habits can help people manage their health. At the bottom of the screen is a Sync Health Data button and a Skip for Now button.](https://docs-assets.developer.apple.com/published/50410b9d99b8e796d03d763d8dddc14c/health-icon-onboard-screen%402x.png)
-
-**Use only the Apple-provided icon.** Don’t create your own Apple Health icon design or attempt to mimic any Apple-provided designs. Download the Apple Health app icon from [Apple Design Resources](https://developer.apple.com/design/resources/#technologies).
-
-**Display the name _Apple Health_ close to the Apple Health icon.** Displaying both elements near each other reminds people that the icon represents the Health app.
-
-**Display the Apple Health icon consistently with other health-related app icons.** In a view that contains other app icons, make the Apple Health icon no smaller than other icons.
-
-**Don’t use the Apple Health icon as a button.** Use the icon only to indicate compatibility with the Health app.
-
-**Don’t alter the appearance of the Apple Health icon.** Don’t mask the icon to change its corner radius or present it in a circular shape. Don’t add embellishments like borders, color overlays, gradients, shadows, or other visual effects.
-
-**Maintain a minimum clear space around the Apple Health icon of 1/10 of its height.** Don’t composite the icon onto another graphic element.
-
-**Don’t use the Apple Health icon within text or as a replacement for the terms _Health_ , _Apple Health_ , or _HealthKit_.** See [Editorial guidelines](https://developer.apple.com/design/human-interface-guidelines/healthkit#Editorial-guidelines) to learn how to properly reference the Health app and HealthKit in text.
-
-**Don’t display Health app images or screenshots.** Like all Apple images, these designs are copyrighted and can’t appear in your app or marketing materials. You can include an Activity ring element in your app to display Move, Exercise, and Stand progress; for guidance, see [Activity rings](https://developer.apple.com/design/human-interface-guidelines/healthkit#Activity-rings).
-
-## [Editorial guidelines](https://developer.apple.com/design/human-interface-guidelines/healthkit#Editorial-guidelines)
-
-**Refer to the Health app as _Apple Health_ or _the Apple Health app_.** In your app and marketing text, using _Apple Health_ adds clarity.
-
-**Don’t use the term _HealthKit_.** _HealthKit_ is a developer-facing term that names the framework your app uses to access health data. If you need to explain to people how your app works with their data, use the term _the Apple Health app_. For example, you might say that your app “works with the Apple Health app” or “uses data from the Apple Health app.”
-
-**Use correct capitalization when using the term _Apple Health_.** _Apple Health_ is two words, with an uppercase A and uppercase H, followed by lowercase letters. You can display _Apple Health_ entirely in uppercase only when you need to conform to an established typographic interface style, such as in an app that capitalizes all text.
-
-**Use the system-provided translation of _Health_ to avoid confusing people.** It’s best to refer to the Apple Health app using the translation that people view on their device.
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/healthkit#Platform-considerations)
-
- _No additional considerations for iOS, iPadOS, or watchOS. Not supported in macOS, tvOS, or visionOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/healthkit#Resources)
-
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/healthkit#Related)
-
-[Works with Apple Health](https://developer.apple.com/health-fitness/works-with-apple-health/)
-
-[Activity rings](https://developer.apple.com/design/human-interface-guidelines/activity-rings)
-
-[Apple Design Resources](https://developer.apple.com/design/resources/#technologies)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/healthkit#Developer-documentation)
-
-[HealthKit](https://developer.apple.com/documentation/HealthKit)
-
-[Protecting user privacy](https://developer.apple.com/documentation/HealthKit/protecting-user-privacy) — HealthKit
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/healthkit#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/7DE5718A-6B6C-41A6-A60B-2C9A6D7B7CE1/9855_wide_250x141_1x.jpg) Meet the HealthKit Medications API ](https://developer.apple.com/videos/play/wwdc2025/321)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/3055294D-836B-4513-B7B0-0BC5666246B0/12499BF9-8217-4A56-81CA-5E7CB66904DD/9856_wide_250x141_1x.jpg) Track workouts with HealthKit on iOS and iPadOS ](https://developer.apple.com/videos/play/wwdc2025/322)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/C03E6E6D-A32A-41D0-9E50-C3C6059820AA/A7FCCDAF-8770-4E6C-86A2-56DDB2095E3E/9232_wide_250x141_1x.jpg) Explore wellbeing APIs in HealthKit ](https://developer.apple.com/videos/play/wwdc2024/10109)
-

package/templates/vault/hig-technologies/references/homekit.md

@@ -1,343 +0,0 @@
----
-title: "HomeKit | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/homekit
-
-# HomeKit
-
-HomeKit lets people securely control connected accessories in their homes using Siri or the Home app on iPhone, iPad, Apple Watch, and Mac.
-
-![A sketch of the HomeKit icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/ebafbd857c1881bf0f090c3592d8a2d6/technologies-HomeKit-intro%402x.png)
-
-In iOS, the Home app also lets people manage and configure accessories.
-
-Your iOS, tvOS, or watchOS app can integrate with HomeKit (and by extension the Home app) to provide a custom or accessory-specific experience. For example, you can:
-
-  * Help people set up, name, and organize their accessories
-
-  * Allow fine-grained accessory configuration and control
-
-  * Provide access to custom accessory features
-
-  * Show people how to create powerful, hands-free automations
-
-  * Provide support
-
-
-
-
-For developer guidance, see [HomeKit](https://developer.apple.com/documentation/HomeKit). If you’re an MFi licensee, visit the [MFi portal](https://mfi.apple.com) for guidance on naming and messaging for accessory packaging.
-
-## [Terminology and layout](https://developer.apple.com/design/human-interface-guidelines/homekit#Terminology-and-layout)
-
-HomeKit models the home as a hierarchy of objects and defines a vocabulary of terms that refer to them. The Home app uses the HomeKit object model and terminology to give people intuitive control of accessories by voice, app, and automation.
-
-It’s crucial for your app to use the terminology and object model that HomeKit defines, so that you can reinforce people’s understanding and make home automation feel approachable.
-
-In the HomeKit model, the [home](https://developer.apple.com/design/human-interface-guidelines/homekit#Homes) object is the root of a hierarchy that contains all other objects, such as [rooms](https://developer.apple.com/design/human-interface-guidelines/homekit#Rooms), [accessories](https://developer.apple.com/design/human-interface-guidelines/homekit#Accessories-services-and-characteristics), and [zones](https://developer.apple.com/design/human-interface-guidelines/homekit#Zones). When there’s more than one home, each home is the root of a different hierarchy.
-
-**Acknowledge the hierarchical model that HomeKit uses.** Even if your app doesn’t organize accessories by rooms and zones in its UI, it’s useful to reference the HomeKit model when helping people set up or control their accessories. People need to know where accessories are located so they can use Siri and HomePod to control them by speaking commands like “Siri, turn on the lights upstairs,” or “It’s dark in here.” For more guidance, see [Siri interactions](https://developer.apple.com/design/human-interface-guidelines/homekit#Siri-interactions).
-
-**Make it easy for people to find an accessory’s related HomeKit details.** If your app’s organization is based on accessories, don’t hide other HomeKit information, such as an accessory’s zone or room, in a hard-to-discover settings screen. Instead, consider making the related HomeKit information easily available in an accessory detail view.
-
-**Recognize that people can have more than one home.** Even if your app doesn’t support the concept of multiple homes per user, consider providing the relevant home information in an accessory detail view.
-
-**Don’t present duplicate home settings.** If your app has a different perspective on the organization of a home, don’t confuse people by asking them to set up all or parts of their homes again or by showing a duplicate settings view. Always defer to the settings people made in the Home app and find an intuitive way to present these details in your UI.
-
-### [Homes](https://developer.apple.com/design/human-interface-guidelines/homekit#Homes)
-
-HomeKit uses the term _home_ to represent a physical home, office, or other location of relevance to people. One person might have multiple homes.
-
-### [Rooms](https://developer.apple.com/design/human-interface-guidelines/homekit#Rooms)
-
-A _room_ represents a physical room in a home. Rooms don’t have attributes like size or location; they’re simply names that have meaning to people, such as _Bedroom_ or _Office_. When people assign accessories to a room, they can use voice commands like “Siri, turn on all the lights except the bedroom,” or “Siri, turn on the kitchen and hallway lights.”
-
-### [Accessories, services, and characteristics](https://developer.apple.com/design/human-interface-guidelines/homekit#Accessories-services-and-characteristics)
-
-The term _accessory_ represents a physical, connected home accessory, like a ceiling fan, lamp, lock, or camera. HomeKit uses _category_ to represent a type of accessory, such as thermostat, fan, or light. Typically, an accessory manufacturer assigns each accessory to a category, but your app can help people make this assignment if necessary. For example, a switch that’s connected to a fan or a lamp needs to be assigned to the same category as the accessory it controls.
-
-A controllable feature of an accessory, such as the switch on a connected light, is known as a _service_. Some accessories offer multiple services. For example, a connected garage door might let people control the light and the door separately, or a connected outlet might support separate control of the top outlet and the bottom outlet. Apps don’t use the word _service_ in the UI; instead, they use names that describe the service, such as _garage door opener_ and _ceiling fan light_. When people use Siri to control the accessories in their homes, they speak the service name, not the accessory name. For more guidance on naming, see [Help people choose useful names](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names).
-
-A _characteristic_ is a controllable attribute of a service. For example, in a ceiling fan, the fan service might have a speed characteristic and the light service might have a brightness characteristic. Apps don’t use the word _characteristic_ in the UI; instead, they use terms that describe the attribute, such as _speed_ and _brightness_.
-
-A _service group_ represents a group of accessory services that someone might want to control as a unit. For example, if there’s a floor lamp and two table lamps in one corner of a room, people might assign all three services to a service group named _reading lamps_. Doing so would let people use the _reading lamps_ service group to control these three lights independently of all other lights in the room.
-
-### [Actions and scenes](https://developer.apple.com/design/human-interface-guidelines/homekit#Actions-and-scenes)
-
-The term _action_ refers to the changing of a service’s characteristic, such as adjusting the speed of a fan or the brightness of a light. People and automation can initiate actions.
-
-A _scene_ is a group of actions that control one or more services in one or more accessories. For example, people might create a _Movie Time_ scene that lowers the shades and dims the lights in the living room, or a _Good Morning_ scene that turns on the lights, raises the shades, and starts the coffee maker in the kitchen.
-
-Tip
-
-The HomeKit API uses the term _action set_ instead of _scene_. In your app’s UI, always use the term _scene_.
-
-### [Automations](https://developer.apple.com/design/human-interface-guidelines/homekit#Automations)
-
- _Automations_ cause accessories to react to certain situations, such as when a person’s location changes, a particular time of day occurs, another accessory turns on or off, or a sensor detects something. For example, an automation could turn on the house lights at sunset or when people arrive home.
-
-### [Zones](https://developer.apple.com/design/human-interface-guidelines/homekit#Zones)
-
-A _zone_ represents an area in the home that contains multiple rooms, such as _upstairs_ or _downstairs_. Setting up a zone is optional, but doing so lets people control multiple accessories at one time. For example, assigning all downstairs lights to a zone named _downstairs_ lets people use voice commands like “Siri, turn off all the lights downstairs.”
-
-## [Setup](https://developer.apple.com/design/human-interface-guidelines/homekit#Setup)
-
-**Use the system-provided setup flow to give people a familiar experience.** The HomeKit setup flow works more quickly than traditional setup flows because it lets people name accessories, join networks, pair with HomeKit, assign room and service categories, and designate favorites in just a few steps. Using the system-provided setup flow lets you concentrate on promoting the custom functionality that makes your accessory unique. For developer guidance, see [`performAccessorySetup(using:completionHandler:)`](https://developer.apple.com/documentation/HomeKit/HMAccessorySetupManager/performAccessorySetup\(using:completionHandler:\)).
-
-**Provide context to explain why you need access to people’s Home data.** Create a purpose string with a phrase that describes why you’re asking for permission to access data, such as “Lets you control this accessory with the Apple Home app and Siri across your Apple devices.”
-
-**Don’t require people to create an account or supply personal information.** Instead, defer to HomeKit for any information you might need. If your app provides additional services that require an account, such as cloud services, make account setup optional and wait until after initial HomeKit setup to offer it.
-
-**Honor people’s setup choices.** When people choose to use HomeKit to set up your accessory, don’t force them to set up other platforms during the HomeKit setup flow. A cross-platform setup experience prevents people from using the accessory right away and can cause confusion by presenting too many ways to control the accessory.
-
-**Carefully consider how and when to provide a custom accessory setup experience.** Always begin by presenting the system-provided setup flow. Then, after the accessory’s basic functionality is available, offer a custom post-setup experience that highlights the unique features of your accessory and helps people get the most out of it. For example, a light manufacturer’s app could help people create personalized light scenes in their homes using key colors scanned in from photos in their library.
-
-### [Help people choose useful names](https://developer.apple.com/design/human-interface-guidelines/homekit#Help-people-choose-useful-names)
-
-**Suggest service names that suit your accessory.** If your app detects when someone creates a suboptimal name for Siri voice controls, recommend alternatives that you know will work well for most people. Never suggest company names or model numbers for use as service names.
-
-**Check that the names people provide follow HomeKit naming rules.** If your app lets people rename services, make sure that the new names follow the rules. (The system-provided setup flow automatically checks the original names.) If people enter a name that breaks one or more rules, briefly explain the problem and suggest some alternative names that work. Here are the rules:
-
-  * Use only alphanumeric, space, and apostrophe characters.
-
-  * Start and end with an alphabetic or numeric character.
-
-  * Don’t include emojis.
-
-
-
-
-| Example service names  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Reading lamp  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| 📚 lamp  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| 2nd garage door  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| #2 garage door  
-  
-**Help people avoid creating names that include location information.** Although it’s natural for someone to use “kitchen light” to name a light in the kitchen, including the room name in the service name can lead to unpredictable results when controlling the accessory by voice. Your app can detect service names that duplicate location information and help people fix them. For example, you might present a post-setup experience that removes the room or zone from a service name and encourages people to assign the accessory to that room or zone instead.
-
-## [Siri interactions](https://developer.apple.com/design/human-interface-guidelines/homekit#Siri-interactions)
-
-HomeKit supports powerful, hands-free control using voice commands. You can help people use Siri to interact with accessories, services, and zones in their home quickly and efficiently.
-
-**Present example voice commands to demonstrate using Siri to control accessories during setup.** As soon as people complete the setup of a new accessory, consider using the service name they chose in a few example Siri phrases and encourage people to try them out.
-
-**After setup, consider teaching people about more complex Siri commands.** People might not be aware of the broad range of natural language phrases they can use with Siri and HomePod to control their accessories. After setup is complete, find useful places throughout your app to help people learn about these types of commands. For example, in a scene detail view, you could tell people, _You can say “Hey Siri, set ‘Movie Time.’”_
-
-In addition to recognizing the names of homes, rooms, zones, services, and scenes, Siri can also use information such as accessory category and characteristic to identify a service. For example, when people use terms like _brighter_ or _dim_ , Siri recognizes that they’re referring to a service that has a brightness characteristic, even if they don’t speak the name of the service.
-
-To illustrate the power and flexibility of Siri commands, here are some examples of the types of phrases that people could use to control their accessories.
-
-Phrase| Siri understands  
----|---  
-“Turn on the floor lamp”| Service (_floor lamp_)  
-“Show me the entryway camera”| Service (_entryway camera_)  
-“Turn on the light”| Accessory category (_light_)  
-“Turn off the living room light”| Room (_living room_)  
-Accessory category (_light_)  
-“Make the living room a little bit brighter”| Room (_living room_)  
-Accessory category (implied)  
-Brightness characteristic (_brighter_)  
-“Turn on the recessed lights”| Service group (_recessed lights_)  
-“Turn off the lights upstairs”| Accessory category (_lights_)  
-Zone (_upstairs_)  
-“Dim the lights in the bedroom and nursery”| Accessory category (_lights_)  
-Brightness characteristic (_dim_)  
-Rooms (_bedroom_ , _nursery_)  
-“Run Good night”| Scene (_Good night_)  
-“Is someone in the living room?”| Accessory category (implied)  
-Occupancy detection characteristic (implied)  
-“Is my security system tripped?”| Accessory category (_security system_)  
-“Did I leave the garage door open?”| Accessory category (_garage door_)  
-Open characteristic (_open_)  
-“Did I forget to turn off the lights in the Tahoe House?”| Accessory category (_lights_)  
-Home (_Tahoe House_)  
-“It’s dark in here”| Current home (_here_)  
-Current room (via HomePod)  
-Accessory category (implied)  
-  
-**Recommend that people create zones and service groups, if they make sense for your accessory.** If people might benefit from using context-specific voice commands to control your accessory, suggest these types of interactions and help people set them up. For example, if you provide an accessory such as a light, switch, or thermostat, you could suggest setting up a zone named “upstairs” or a service group named “media center” to support commands like “Siri, turn off the upstairs lights,” or “Siri, activate the media center.”
-
-**Offer shortcuts only for accessory-specific functionality that HomeKit doesn’t support.** HomeKit lets people use ordinary (or natural) language to control accessories without requiring any additional configuration, so you avoid confusing people by offering shortcuts that duplicate HomeKit functionality. Instead, consider offering shortcuts for complementary functionality that your app provides. For example, if people often want to order filters for an air conditioner that you support, you might offer a shortcut like “Order AC filters.” To learn how to provide phrases that people can use for shortcuts, see [Shortcuts and suggestions](https://developer.apple.com/design/human-interface-guidelines/siri#Shortcuts-and-suggestions).
-
-**If your app supports both HomeKit and shortcuts, help people understand the difference between these types of voice control.** People can get confused if they’re presented with multiple methods of voice control. Be sure you clearly indicate what’s possible with shortcuts, and never encourage people to create a shortcut for a scene or action that HomeKit already supports.
-
-## [Custom functionality](https://developer.apple.com/design/human-interface-guidelines/homekit#Custom-functionality)
-
-Your app is a great place to help people appreciate the unique functionality of your accessory. For example, an app for a light that displays different colors could help people create HomeKit scenes using colors imported from their photos.
-
-**Be clear about what people can do in your app and when they might want to use the Home app.** For example, if your app supports only lights, consider encouraging people to create a “Movie Time” scene that not only dims the lights, but also closes the shades, and turns on the TV to a specific input. To do this, first guide people to set up a scene that includes only your accessory’s actions — in this scenario, dimming the lights. Then, your app can suggest that people open the Home app to add their HomeKit-compatible shades and TV to the scene you helped them create. For guidance on how to refer to the Home app, see [Referring to HomeKit](https://developer.apple.com/design/human-interface-guidelines/homekit#Referring-to-HomeKit).
-
-**Defer to HomeKit if your database differs from the HomeKit database.** Give people a seamless experience by automatically reflecting changes made in the Home app or in other third-party HomeKit apps. If you must ask people to manage conflicts in your app, present the conflict visually so that they have a clear picture of the choice they need to confirm. For example, if someone changes an accessory’s service name in the Home app, your app can detect this change and could show both names side by side to confirm that the person wants to use the new name in your app, too.
-
-**Ask permission to update the HomeKit database when people make changes in your app.** You don’t want to surprise people by changing something in the Home app, so it’s essential to get permission or an indication of intent before you write to the database. In particular, never overwrite HomeKit database settings without a person’s explicit direction.
-
-### [Cameras](https://developer.apple.com/design/human-interface-guidelines/homekit#Cameras)
-
-Your app can display still images or streaming video from a connected HomeKit IP camera.
-
-**Don’t block camera images.** It’s fine to supplement the camera’s content with useful features, such as an alert calling attention to potentially interesting activity. However, avoid covering portions of the camera’s images with other content.
-
-**Show a microphone button only if the camera supports bidirectional audio.** A nonfunctioning microphone button takes up valuable display space in your app and risks confusing people.
-
-## [Using HomeKit icons](https://developer.apple.com/design/human-interface-guidelines/homekit#Using-HomeKit-icons)
-
-Use the HomeKit icon in setup or instructional communications related to HomeKit technology.
-
-![The HomeKit icon.](https://docs-assets.developer.apple.com/published/926a46dc1cdf9647a94303a329c43645/homekit-glyph%402x.png)
-
-In addition, you can use the Apple Home app icon when referencing the Apple Home app or in a button that opens the Apple Home app [product page](https://itunes.apple.com/us/app/home/id1110145103?mt=8) in the App Store.
-
-![The Apple Home app icon, which includes a stylized house with a chimney on the right side of its roof, depicted in graduated shades of orange.](https://docs-assets.developer.apple.com/published/2dd7e937870e9cde3c818264d031e15c/homeapp-icon%402x.png)
-
-**Use only Apple-provided icons.** Don’t create your own HomeKit or Home app icon design or attempt to mimic the Apple-provided designs. Download HomeKit icons in [Resources](https://developer.apple.com/design/resources/).
-
-### [Styles](https://developer.apple.com/design/human-interface-guidelines/homekit#Styles)
-
-You have several options for displaying the HomeKit icon.
-
-#### [Black HomeKit icon](https://developer.apple.com/design/human-interface-guidelines/homekit#Black-HomeKit-icon)
-
-Use the HomeKit icon on white or light backgrounds when other technology icons appear in black.
-
-![A black outlined HomeKit icon.](https://docs-assets.developer.apple.com/published/739a8ed96d427f7a1e8eb680feab203c/homekit-black-icon-set%402x.png)
-
-#### [White HomeKit icon](https://developer.apple.com/design/human-interface-guidelines/homekit#White-HomeKit-icon)
-
-Use the HomeKit icon on black or dark backgrounds when other technology icons appear in white.
-
-![A white outlined HomeKit icon.](https://docs-assets.developer.apple.com/published/86f0a2b6f128e579b0b2400f3e8c7fa7/homekit-white-icon-set%402x.png)
-
-#### [Custom color HomeKit icon](https://developer.apple.com/design/human-interface-guidelines/homekit#Custom-color-HomeKit-icon)
-
-Use a custom color when other technology icons appear in the same color.
-
-![A blue outlined HomeKit icon.](https://docs-assets.developer.apple.com/published/f7e6e6aaf077dbcb7cba53cbadf8436d/homekit-custom-color-icon-set%402x.png)
-
-**Position the HomeKit icon consistently with other technology icons.** When other technology icons are contained within shapes, treat the HomeKit icon in the same manner.
-
-![An illustration of three app icons listed in a horizontal row. Text above the icons reads 'Integrate with'. The leftmost app icon is the HomeKit icon in a circle, above the text 'Apple HomeKit'. The remaining two app icons contain squares with dashed frames witihn circles, above text that reads 'Technology'.](https://docs-assets.developer.apple.com/published/d4b79f9c55760002e886eb66776c4044/homekit-settings%402x.png)
-
-**Use the HomeKit icon noninteractively.** Don’t use the icon and the name _HomeKit_ in custom interactive elements or buttons. You can use the Apple Home app icon to open the app’s product page in the App Store.
-
-![An illustration of an incorrectly used HomeKit icon in a circular button styled with a chrome appearance.](https://docs-assets.developer.apple.com/published/08c6b1888cd04ea864bfe8d037eb1814/homekit-donot1%402x.png)
-
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)
-
-![An illustration of a button incorrectly titled 'HomeKit' with a custom gradient background.](https://docs-assets.developer.apple.com/published/0c8ae4ebd1f0d755d78391a46602eda0/homekit-donot2%402x.png)
-
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)
-
-**Don’t use the HomeKit icon within text or as a replacement for the word HomeKit.** See [Referring to HomeKit](https://developer.apple.com/design/human-interface-guidelines/homekit#Referring-to-HomeKit) to learn how to properly reference HomeKit in text.
-
-![The first in a series of images showing examples of the HomeKit icon when used in text. In this example, the icon correctly appears first in the line, and then the text 'Lights set with HomeKit.'](https://docs-assets.developer.apple.com/published/36d82399473bdcb7c28130fd4451d8a2/homekit-lights-right%402x.png)
-
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)
-
-![The second in a series of images showing examples of the HomeKit icon when used in text. This example depicts the icon incorrectly positioned after the word 'with' in the text 'Lights set with HomeKit.'](https://docs-assets.developer.apple.com/published/c807ea2f349cf7b4765dbf556583c701/homekit-lights-wrong1%402x.png)
-
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)
-
-![The third in a series of images showing examples of the HomeKit icon when used in text. This example depicts the icon incorrectly positioned at the end of the line of text that reads 'Lights set with'.](https://docs-assets.developer.apple.com/published/5b77fd061bc43cba46493fd96a9bae74/homekit-lights-wrong2%402x.png)
-
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)
-
-**Pair the icon with the name _HomeKit_ correctly.** You can show the name below or beside the icon if other technologies are referenced in this way. Use the same font that’s used on the rest of your layout. For related guidance, see [Referring to HomeKit](https://developer.apple.com/design/human-interface-guidelines/homekit#Referring-to-HomeKit).
-
-![An illustration of a view containing setup information within an app. The top of the view includes the title 'Setup' above a divider line. Three rows with icons, text, and disclosure buttons for displaying additional information appear below the divider. The first row includes the HomeKit icon followed by the word 'HomeKit'. The other  two rows display dashed squares representing other app icons, each followed by the word 'Name'.](https://docs-assets.developer.apple.com/published/e3e956f06b1658b6e2a1776c9015ad66/homekit-setup%402x.png)Using the icon and name in setup or instructional content
-
-![An illustration of a view containing a grid of four app buttons. The top of the view includes the title 'Apps' above a divider line. Two rows of buttons and labels appear below the divider. The first button in the first row includes the Apple Home app icon, and appears above the text 'Apple Home'. The remaining buttons include dashed squares representing other app icons, and each appears above the text 'App Name'.](https://docs-assets.developer.apple.com/published/2ff6f6ad2861c485ab76b4f2561de95e/homekit-apps%402x.png)Using the icon and name referencing the Apple Home app
-
-## [Referring to HomeKit](https://developer.apple.com/design/human-interface-guidelines/homekit#Referring-to-HomeKit)
-
-**Emphasize your app over HomeKit.** Make references to HomeKit or Apple Home less prominent than your app name or main identity.
-
-**Adhere to Apple’s trademark guidelines.** Apple trademarks can’t appear in your app name or images. In text, use Apple product names exactly as shown on the [Apple Trademark List](https://www.apple.com/legal/intellectual-property/trademark/appletmlist.html).
-
-  * Use Apple product names in singular form only; do not make Apple product names possessive.
-
-  * Don’t translate Apple, Apple Home, HomeKit, or any other Apple trademark.
-
-  * Don’t use category descriptors. For example, say iPad, not tablet.
-
-  * Don’t indicate any kind of sponsorship, partnership, or endorsement from Apple.
-
-  * Attribute Apple, HomeKit, and all other Apple trademarks with the correct credit lines wherever legal information appears within your app.
-
-  * Refer to Apple devices and operating systems only in technical specifications or compatibility descriptions.
-
-
-
-
-| Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Use HomeKit to turn on your lights from your iPhone or iPad.  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| Use HomeKit to turn on your lights from your iOS devices.  
-  
-See [Guidelines for Using Apple Trademarks](https://www.apple.com/legal/intellectual-property/guidelinesfor3rdparties.html).
-
-### [Referencing HomeKit and the Home app](https://developer.apple.com/design/human-interface-guidelines/homekit#Referencing-HomeKit-and-the-Home-app)
-
-**Use correct capitalization when using the term _HomeKit_.** _HomeKit_ is one word, with an uppercase _H_ and uppercase _K_ , followed by lowercase letters. _Apple Home_ is two words, with an uppercase _A_ and uppercase _H_ , followed by lowercase letters. If your layout displays only all-uppercase designations, _HomeKit_ or _Apple Home_ can be typeset in all uppercase to match the style of the rest of the layout.
-
-**Don’t use the name _HomeKit_ as a descriptor.** Instead use terms like _works with_ , _use_ , _supports_ , or _compatible_.
-
-| Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| [Brand] lightbulbs work with HomeKit.  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| HomeKit-enabled thermostat.  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| You can use HomeKit with [App Name].  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| HomeKit lightbulbs.  
-  
-**Don’t suggest that HomeKit is performing an action or function.**
-
-|  Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Back door is unlocked with HomeKit.  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| HomeKit unlocked the back door.  
-  
-**Use the name _Apple_ with the name _HomeKit_ , if desired.**
-
-| Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Compatible with Apple HomeKit.  
-  
-**Use the name _HomeKit_ for setup, configuration, and instructions, if desired.**
-
-| Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Open HomeKit settings.  
-  
-**Use the app name _Apple Home_ whenever referring specifically to the app.** On the first mention of the app in body copy, use the complete name _Apple Home_. Subsequent mentions can refer to the Home app.
-
-| Example text  
----|---  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Open the Apple Home app.  
-![A checkmark in a circle to indicate correct usage.](https://docs-assets.developer.apple.com/published/88662da92338267bb64cd2275c84e484/checkmark%402x.png)| Open the Apple Home app. Your accessory and room will now appear in the Home app.  
-![An X in a circle to indicate incorrect usage.](https://docs-assets.developer.apple.com/published/209f6f0fc8ad99d9bf59e12d82d06584/crossout%402x.png)| Open Home.  
-  
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/homekit#Platform-considerations)
-
- _No additional considerations for iOS, iPadOS, macOS, tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/homekit#Resources)
-
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/homekit#Related)
-
-[Apple Design Resources](https://developer.apple.com/design/resources/)
-
-[Guidelines for Using Apple Trademarks and Copyrights](https://www.apple.com/legal/intellectual-property/guidelinesfor3rdparties.html)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/homekit#Developer-documentation)
-
-[HomeKit](https://developer.apple.com/documentation/HomeKit)
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/homekit#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/119/8C81F0E7-2E4C-4F4F-82FE-A9EBC73A913D/5239_wide_250x141_1x.jpg) Add support for Matter in your smart home app ](https://developer.apple.com/videos/play/wwdc2021/10298)
-
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/homekit#Change-log)
-
-Date| Changes  
----|---  
-May 2, 2023| Consolidated guidance into one page.  
-  

package/templates/vault/hig-technologies/references/icloud.md

@@ -1,52 +0,0 @@
----
-title: "iCloud | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/icloud
-
-# iCloud
-
-iCloud is a service that lets people seamlessly access the content they care about — photos, videos, documents, and more — from any device, without performing explicit synchronization.
-
-![A sketch of the iCloud icon. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/928d419006d55a9003163836f73f4339/technologies-iCloud-intro%402x.png)
-
-A fundamental aspect of iCloud is transparency. People don’t need to know where content resides. They can just assume they’re always accessing the latest version.
-
-## [Best practices](https://developer.apple.com/design/human-interface-guidelines/icloud#Best-practices)
-
-**Make it easy to use your app with iCloud.** People turn on iCloud in Settings and expect apps to work with it automatically. If you think people might want to choose whether to use iCloud with your app, show a simple option the first time your app opens that provides a choice between using iCloud for all data or not at all.
-
-**Avoid asking which documents to keep in iCloud.** Most people expect all of their content to be available in iCloud and don’t want to manage the storage of individual documents. Consider how your app handles and exposes content, and try to perform more file-management tasks automatically.
-
-**Keep content up to date when possible.** In an app that supports iCloud, it’s best when people always have access to the most recent content. However, you need to balance this experience with respect to device storage and bandwidth constraints. If your app works with very large documents, it may be better to let people control when updated content is downloaded. If your app fits in this category, design a way to indicate that a more recent version of a document is available in iCloud. When a document is updating, provide subtle feedback if the download takes more than a few seconds.
-
-**Respect iCloud storage space.** iCloud is a finite resource for which people pay. Use iCloud to store information people create and understand, and avoid using it for app resources or content you can regenerate. Even if your app doesn’t implement iCloud support, remember that iCloud backups include the contents of every app’s Documents folder. To avoid using up too much space, be picky about the content you place in the Documents folder.
-
-**Make sure your app behaves appropriately when iCloud is unavailable.** If someone manually turns off iCloud or turns on Airplane Mode, you don’t need to display an alert notifying them iCloud is unavailable. However, it may still be helpful to unobtrusively let people know that changes they make won’t be available on other devices until they restore iCloud access.
-
-**Keep app state information in iCloud.** In addition to storing documents and other files, you can use iCloud to store settings and information about the state of your app. For example, a magazine app might store the last page viewed so when the app is opened on another device, someone can continue reading from where they left off. If you use iCloud to store settings, make sure it’s for ones people want applied to all of their devices. For example, some settings might be more useful at work than at home.
-
-**Warn about the consequences of deleting a document.** When someone deletes a document in an app that supports iCloud, the document is removed from iCloud and all other devices too. Show a warning and ask for confirmation before performing the deletion.
-
-**Make conflict resolution prompt and easy.** To the extent possible, try to detect and resolve version conflicts automatically. If this can’t be done, display an unobtrusive notification that makes it easy to differentiate and choose between the conflicting versions. Ideally, conflict resolution occurs as early as possible, so time isn’t wasted in the wrong version.
-
-**Include iCloud content in search results.** People with iCloud accounts assume their content is universally available, and they expect search results to reflect this perspective.
-
-**For games, consider saving player progress in iCloud.** Although you can implement this functionality yourself, the GameSave framework offers an efficient solution. It synchronizes save data across devices and offers built-in alerts you can use to help players handle syncing issues during offline play or when conflicts arise. Alternatively, you can implement custom UI that uses GameSave data to resolve these situations. For developer guidance, see [GameSave](https://developer.apple.com/documentation/GameSave).
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/icloud#Platform-considerations)
-
- _No additional considerations for iOS, iPadOS, macOS, tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/icloud#Resources)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/icloud#Developer-documentation)
-
-[CloudKit](https://developer.apple.com/documentation/CloudKit)
-
-[GameSave](https://developer.apple.com/documentation/GameSave)
-
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/icloud#Change-log)
-
-Date| Changes  
----|---  
-June 9, 2025| Added guidance for synchronizing game data through iCloud.  
-  

package/templates/vault/hig-technologies/references/id-verifier.md

@@ -1,73 +0,0 @@
----
-title: "ID Verifier | Apple Developer Documentation"
-source: https://developer.apple.com/design/human-interface-guidelines/id-verifier
-
-# ID Verifier
-
-ID Verifier lets your iPhone app read mobile IDs in person without requiring external hardware.
-
-![A sketch of progressively larger curved lines emerging from the bottom corner of an ID card, suggesting ID Verifier. The image is overlaid with rectangular and circular grid lines and is tinted blue to subtly reflect the blue in the original six-color Apple logo.](https://docs-assets.developer.apple.com/published/8d77246d289837a097f0556d6e7d2c7d/technologies-ID-Verifier-Apps-intro%402x.png)
-
-Beginning in iOS 17, you can integrate ID Verifier into your app, letting iPhone read ISO18013-5 compliant mobile IDs and helping you support in-person ID verification. For example, personnel at a concert venue can use your app on iPhone to verify customers’ ages.
-
-Using ID Verifier has advantages for both customers and organizations.
-
-  * Customers only present the minimum data needed to prove their age or identity, without handing over their ID card or showing their device.
-
-  * Apple provides the key components of the certificate issuance, management, and validation process, simplifying app development and enabling a consistent and trusted ID verification experience.
-
-
-
-
-Depending on the needs of your app, you can use ID Verifier to make the following types of requests:
-
-  * **Display Only request.** Use a Display Only request to display data — such as a person’s name or age alongside their photo portrait — within system-provided UI on the requester’s iPhone, so the requester can visually confirm the person’s identity. When you make a Display Only request, the customer’s data remains within the system-provided UI and isn’t transmitted to your app. For developer guidance, see [`MobileDriversLicenseDisplayRequest`](https://developer.apple.com/documentation/ProximityReader/MobileDriversLicenseDisplayRequest).
-
-  * **Data Transfer request.** Use a Data Transfer request only when you have a legal verification requirement and you need to store or process information like a person’s address or date of birth. You must request an additional entitlement to make a Data Transfer request. To learn more, see [Get started with ID Verifier](https://developer.apple.com/wallet/id-verifier/); for developer guidance, see [`MobileDriversLicenseDataRequest`](https://developer.apple.com/documentation/ProximityReader/MobileDriversLicenseDataRequest) and [`MobileDriversLicenseRawDataRequest`](https://developer.apple.com/documentation/ProximityReader/MobileDriversLicenseRawDataRequest).
-
-
-
-
-## [Best practices](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Best-practices)
-
-**Ask only for the data you need.** People may lose trust in the experience if you ask for more data than you need to complete the current verification. For example, if you need to ensure that a customer is at least a minimum age, use a request that specifies an age threshold; avoid requesting the customer’s current age or birth date. For developer guidance, see [`ageAtLeast(_:)`](https://developer.apple.com/documentation/ProximityReader/MobileDriversLicenseDataRequest/Element/ageAtLeast\(_:\)).
-
-**If your app qualifies for Apple Business Register, register for ID Verifier to ensure that people can view essential information about your organization when you make a request.** Registering for ID Verifier with Apple Business Register lets you provide your official organization name and logo for the system to display on customers’ devices as part of the ID verification UI. To learn if your app qualifies and how to register, see [Apple Business Register](https://register.apple.com/services/login?returnTo=/signin/tap-to-present-id-on-iphone).
-
-**Provide a button that initiates the verification process.** Use a label like Verify Age in a button that performs a simple age check or Verify Identity for a more detailed identity data request. Avoid including a symbol that specifies a particular type of communication, like NFC or QR codes. Never include the Apple logo in any button label.
-
-Button type| Example usage  
----|---  
-![An illustration of a Verify Age button.](https://docs-assets.developer.apple.com/published/68f99fdea3def2ba04aee092c3465400/id-verifier-button-age%402x.png)| An app that checks whether people are old enough to attend an event or access a venue, like a concert hall.  
-![An illustration of a Verify Identity button.](https://docs-assets.developer.apple.com/published/1e827d68149ef111a2ff7ebec21912a0/id-verifier-button-identity%402x.png)| An app that verifies whether specific identity information matches expected values, such as name and birth date when picking up a rental car.  
-  
-**In a Display Only request, help the person using your app provide feedback on the visual confirmation they perform.** For example, when the reader displays the customer’s portrait, you might provide buttons labeled Matches Person and Doesn’t Match Person so your app can receive an approved or rejected value as part of the response.
-
-## [Platform considerations](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Platform-considerations)
-
- _No additional considerations for iOS. Not supported in iPadOS, macOS, tvOS, visionOS, or watchOS._
-
-## [Resources](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Resources)
-
-#### [Related](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Related)
-
-[Apple Business Register](https://register.apple.com/services/login?returnTo=/signin/tap-to-present-id-on-iphone)
-
-[IDs in Wallet](https://learn.wallet.apple/id)
-
-[Identity verification](https://developer.apple.com/design/human-interface-guidelines/wallet#Identity-verification)
-
-#### [Developer documentation](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Developer-documentation)
-
-[Adopting the Verifier API in your iPhone app](https://developer.apple.com/documentation/ProximityReader/adopting-the-verifier-api-in-your-iphone-app) — ProximityReader
-
-#### [Videos](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Videos)
-
-[![](https://devimages-cdn.apple.com/wwdc-services/images/D35E0E85-CCB6-41A1-B227-7995ECD83ED5/0F2B5692-7E7D-4716-9E5F-63E4A4FA13ED/8168_wide_250x141_1x.jpg) What’s new in Wallet and Apple Pay ](https://developer.apple.com/videos/play/wwdc2023/10114)
-
-## [Change log](https://developer.apple.com/design/human-interface-guidelines/id-verifier#Change-log)
-
-Date| Changes  
----|---  
-September 12, 2023| New page.  
-