Skip to content

Commit

Permalink
Update DocC
Browse files Browse the repository at this point in the history
  • Loading branch information
fpseverino committed Dec 28, 2024
1 parent 0535d93 commit e9a0e0f
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ``WalletOrders/OrderJSON``

## Overview

The ``OrderJSON/Properties`` protocol defines the properties that an order JSON object must have. The properties are based on the keys that are used in the JSON representation of an order. See the [`Order`](https://developer.apple.com/documentation/walletorders/order) object to understand the keys.

## Topics

### Essentials
Expand Down
4 changes: 3 additions & 1 deletion Sources/WalletOrders/WalletOrders.docc/WalletOrders.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Create orders for the Apple Wallet app.

## Overview

This package provides tools to create orders for the Apple Wallet app.
The `WalletOrders` framework provides a set of tools to create and build orders trackable in the Apple Wallet app.

For information on Apple Wallet orders, see the [Apple Developer Documentation](https://developer.apple.com/documentation/walletorders).

## Topics

Expand Down
4 changes: 4 additions & 0 deletions Sources/WalletPasses/WalletPasses.docc/Extensions/PassJSON.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ``WalletPasses/PassJSON``

## Overview

The ``PassJSON/Properties`` protocol defines the properties that a pass JSON object must have. The properties are based on the keys that are used in the JSON representation of a pass. See the [`Pass`](https://developer.apple.com/documentation/walletpasses/pass) object to understand the keys.

## Topics

### Essentials
Expand Down
35 changes: 35 additions & 0 deletions Sources/WalletPasses/WalletPasses.docc/PersonalizablePasses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Create a Personalizable Pass

Create and sign personalized passes for the Apple Wallet app.

## Overview

> Warning: This section is a work in progress. Testing is hard without access to the certificates required to develop this feature. If you have access to the entitlements, please help us implement this feature.
Pass Personalization lets you create passes, referred to as personalizable passes, that prompt the user to provide personal information during signup that will be sent to your server.

> Important: Making a pass personalizable, just like adding NFC to a pass, requires a special entitlement issued by Apple. Although accessing such entitlements is hard if you're not a big company, you can learn more in [Getting Started with Apple Wallet](https://developer.apple.com/wallet/get-started/).
Personalizable passes can be distributed like any other pass, but you'll need to setup a web server to handle the personalization.

For information on personalizable passes, see the [Wallet Developer Guide](https://developer.apple.com/library/archive/documentation/UserExperience/Conceptual/PassKit_PG/PassPersonalization.html#//apple_ref/doc/uid/TP40012195-CH12-SW2) and [Return a Personalized Pass](https://developer.apple.com/documentation/walletpasses/return_a_personalized_pass).

### Getting Started

A personalizable pass is just a standard pass package with the following additional files:

- A `personalization.json` file.
- A `[email protected]` file.

To make a pass personalizable, you need to pass a ``PersonalizationJSON`` object to ``PassBuilder/build(pass:sourceFilesDirectoryPath:personalization:)``, and the source files directory must contain the `[email protected]` file.

Once you've built the pass, you can distribute it like any other pass.
The user will be prompted to provide the required personal information when they add the pass.
Wallet will then send the user personal information to your server.
Immediately after that, the Wallet app will request the updated pass.

> Important: The updated and personalized pass **must not** contain the `personalization.json` file.
## Topics

- ``PersonalizationJSON``
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 12 additions & 2 deletions Sources/WalletPasses/WalletPasses.docc/WalletPasses.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ Create passes for the Apple Wallet app.

## Overview

This package provides tools to create passes for the Apple Wallet app.
@Row {
@Column { }
@Column(size: 4) {
![Passes](passes)
}
@Column { }
}

The `WalletPasses` framework provides a set of tools to create and build digital passes for the Apple Wallet app.

For information on Apple Wallet passes, see the [Apple Developer Documentation](https://developer.apple.com/documentation/walletpasses).

## Topics

Expand All @@ -15,7 +25,7 @@ This package provides tools to create passes for the Apple Wallet app.

### Personalized Passes

- ``PersonalizationJSON``
- <doc:PersonalizablePasses>

### Errors

Expand Down

0 comments on commit e9a0e0f

Please sign in to comment.