Skip to content

Commit e9a0e0f

Browse files
committed
Update DocC
1 parent 0535d93 commit e9a0e0f

File tree

6 files changed

+58
-3
lines changed

6 files changed

+58
-3
lines changed

Sources/WalletOrders/WalletOrders.docc/Extensions/OrderJSON.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ``WalletOrders/OrderJSON``
22

3+
## Overview
4+
5+
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.
6+
37
## Topics
48

59
### Essentials

Sources/WalletOrders/WalletOrders.docc/WalletOrders.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Create orders for the Apple Wallet app.
44

55
## Overview
66

7-
This package provides tools to create orders for the Apple Wallet app.
7+
The `WalletOrders` framework provides a set of tools to create and build orders trackable in the Apple Wallet app.
8+
9+
For information on Apple Wallet orders, see the [Apple Developer Documentation](https://developer.apple.com/documentation/walletorders).
810

911
## Topics
1012

Sources/WalletPasses/WalletPasses.docc/Extensions/PassJSON.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# ``WalletPasses/PassJSON``
22

3+
## Overview
4+
5+
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.
6+
37
## Topics
48

59
### Essentials
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Create a Personalizable Pass
2+
3+
Create and sign personalized passes for the Apple Wallet app.
4+
5+
## Overview
6+
7+
> 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.
8+
9+
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.
10+
11+
> 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/).
12+
13+
Personalizable passes can be distributed like any other pass, but you'll need to setup a web server to handle the personalization.
14+
15+
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).
16+
17+
### Getting Started
18+
19+
A personalizable pass is just a standard pass package with the following additional files:
20+
21+
- A `personalization.json` file.
22+
- A `[email protected]` file.
23+
24+
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.
25+
26+
Once you've built the pass, you can distribute it like any other pass.
27+
The user will be prompted to provide the required personal information when they add the pass.
28+
Wallet will then send the user personal information to your server.
29+
Immediately after that, the Wallet app will request the updated pass.
30+
31+
> Important: The updated and personalized pass **must not** contain the `personalization.json` file.
32+
33+
## Topics
34+
35+
- ``PersonalizationJSON``
175 KB
Loading

Sources/WalletPasses/WalletPasses.docc/WalletPasses.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,17 @@ Create passes for the Apple Wallet app.
44

55
## Overview
66

7-
This package provides tools to create passes for the Apple Wallet app.
7+
@Row {
8+
@Column { }
9+
@Column(size: 4) {
10+
![Passes](passes)
11+
}
12+
@Column { }
13+
}
14+
15+
The `WalletPasses` framework provides a set of tools to create and build digital passes for the Apple Wallet app.
16+
17+
For information on Apple Wallet passes, see the [Apple Developer Documentation](https://developer.apple.com/documentation/walletpasses).
818

919
## Topics
1020

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

1626
### Personalized Passes
1727

18-
- ``PersonalizationJSON``
28+
- <doc:PersonalizablePasses>
1929

2030
### Errors
2131

0 commit comments

Comments
 (0)