Methods
All methods are named exports of @reeq/react-native-passkit.
Cross-platform
canAddPasses(format?)
canAddPasses(format?: PassFormat /* 'json' | 'jwt', default 'json' */): Promise<boolean>
Whether the device can add passes. On Android, format selects the Google Wallet API to check. iOS ignores it.
addPass(base64EncodedPass)
addPass(base64EncodedPass: string): Promise<void>
Shows the wallet UI for one pass: a .pkpass on iOS, a JSON payload on Android. Resolves once the UI is presented. The outcome is reported by the result event.
addPasses(base64EncodedPasses) 0.3.0+
addPasses(base64EncodedPasses: string[]): Promise<void>
On iOS, shows one sheet for all passes. On Android, accepts exactly one JSON payload, which can itself contain several objects. See Adding passes.
getWalletName() 0.3.0+
getWalletName(): Promise<string>
Returns "Apple Wallet" on iOS, and "Google Wallet" or "Google Pay" on Android, depending on the market.
Android only
addPassJWT(passJWT)
addPassJWT(passJWT: string): Promise<void>
Saves passes from a signed JWT. Does nothing on iOS.
iOS only
On Android, queries resolve an empty value and mutations reject with E_UNSUPPORTED_PLATFORM.
isPassLibraryAvailable() 0.3.0+
isPassLibraryAvailable(): Promise<boolean>
containsPass(base64EncodedPass)
containsPass(base64EncodedPass: string): Promise<boolean>
getPasses() 0.3.0+
getPasses(): Promise<Pass[]>
Passes the app can access. Requires the Wallet entitlement.
getPass(passTypeIdentifier, serialNumber) 0.3.0+
getPass(passTypeIdentifier: string, serialNumber: string): Promise<Pass | null>
getPassFieldValue(passTypeIdentifier, serialNumber, fieldKey) 0.3.0+
getPassFieldValue(
passTypeIdentifier: string,
serialNumber: string,
fieldKey: string
): Promise<string | null>
The localized value of a pass.json field. Dates are returned as ISO‑8601 strings.
replacePass(base64EncodedPass) 0.3.0+
replacePass(base64EncodedPass: string): Promise<boolean>
Replaces an existing pass without showing UI. Resolves false if it couldn't (for example, when the pass isn't in Wallet).
removePass(passTypeIdentifier, serialNumber) 0.3.0+
removePass(passTypeIdentifier: string, serialNumber: string): Promise<void>
openPass(passTypeIdentifier, serialNumber) 0.3.0+
openPass(passTypeIdentifier: string, serialNumber: string): Promise<void>
Opens the pass in the Wallet app.
Events
addPassResultListener(callback)
addPassResultListener(cb: (event: AddPassResultEvent) => void): () => void
useAddPassResult()
useAddPassResult(): AddPassResultEvent | undefined
passLibraryChangedListener(callback) iOS 0.3.0+
passLibraryChangedListener(cb: (event: PassLibraryChangedEvent) => void): () => void
Listener functions return an unsubscribe function.
Constants
UNSUPPORTED_PLATFORM
'E_UNSUPPORTED_PLATFORM': the code of the rejection when a method isn't available on the current platform.