One Logo Pool Ball
X
Github
Discord

System

PassKit · IOS API REFERENCE

PKPassLibrary

class · iOS 6.0+ · SDK 27.1

class PKPassLibrary

Members (36)

static · iOS 9.0+

endAutomaticPassPresentationSuppression

TypeScript
static endAutomaticPassPresentationSuppression(requestToken: number): void
Swift declaration
class func endAutomaticPassPresentationSuppression(withRequestToken requestToken: PKSuppressionRequestToken)
static · iOS 6.0+

isPassLibraryAvailable

TypeScript
static isPassLibraryAvailable(): boolean
Swift declaration
class func isPassLibraryAvailable() -> Bool
static · iOS 8.0+ · Deprecated in iOS 9.0

isPaymentPassActivationAvailable

TypeScript
static isPaymentPassActivationAvailable(): boolean
Swift declaration
class func isPaymentPassActivationAvailable() -> Bool
static · iOS 9.0+

isSuppressingAutomaticPassPresentation

TypeScript
static isSuppressingAutomaticPassPresentation(): boolean
Swift declaration
class func isSuppressingAutomaticPassPresentation() -> Bool
static · iOS 9.0+

requestAutomaticPassPresentationSuppression

TypeScript
static requestAutomaticPassPresentationSuppression(responseHandler: ((arg0: PKAutomaticPassPresentationSuppressionResult) => void)): number
Swift declaration
class func requestAutomaticPassPresentationSuppression(responseHandler: @escaping (PKAutomaticPassPresentationSuppressionResult) -> Void) -> PKSuppressionRequestToken
method · iOS 8.0+ · Deprecated in iOS 9.0

activate

TypeScript
activateWithActivationCodeCompletion(paymentPass: PKPaymentPass, activationCode: string, completion?: (((arg0: boolean, arg1: NativeError) => void)) | null): void
Swift declaration
func activate(_ paymentPass: PKPaymentPass, withActivationCode activationCode: String, completion: ((Bool, any Error) -> Void)? = nil)
method · iOS 8.0+ · Deprecated in iOS 100000.0

activate

TypeScript
activateWithActivationDataCompletion(paymentPass: PKPaymentPass, activationData: ArrayBuffer, completion?: (((arg0: boolean, arg1: NativeError) => void)) | null): void
Swift declaration
func activate(_ paymentPass: PKPaymentPass, withActivationData activationData: Data, completion: ((Bool, any Error) -> Void)? = nil)
method · iOS 13.4+

activate

TypeScript
activateActivationDataCompletion(secureElementPass: PKSecureElementPass, activationData: ArrayBuffer, completion?: (((arg0: boolean, arg1: (NativeError) | null) => void)) | null): void
Swift declaration
func activate(_ secureElementPass: PKSecureElementPass, activationData: Data) async throws -> Bool
method · iOS 7.0+

addPasses

TypeScript
addPassesWithCompletionHandler(passes: Array<PKPass>, completion?: (((arg0: PKPassLibraryAddPassesStatus) => void)) | null): void
Swift declaration
func addPasses(_ passes: [PKPass]) async -> PKPassLibraryAddPassesStatus
method · iOS 27.0+

addPasses

TypeScript
addPassesFromArchiveAtCompletion(passesArchiveFileURL: string, completionHandler: ((arg0: PKPassLibraryAddPassesStatus) => void)): void
Swift declaration
func addPasses(fromArchiveAt passesArchiveFileURL: URL) async -> PKPassLibraryAddPassesStatus
method · iOS 27.0+

addPasses

TypeScript
addPassesFromArchiveDataCompletion(passesArchiveData: ArrayBuffer, completionHandler: ((arg0: PKPassLibraryAddPassesStatus) => void)): void
Swift declaration
func addPasses(fromArchiveData passesArchiveData: Data) async -> PKPassLibraryAddPassesStatus
method · iOS 27.0+

addPasses

TypeScript
addPassesDataCompletion(passesData: Array<ArrayBuffer>, completionHandler: ((arg0: PKPassLibraryAddPassesStatus) => void)): void
Swift declaration
func addPasses(data passesData: [Data]) async -> PKPassLibraryAddPassesStatus
method · iOS 26.0+

authorizationStatus

TypeScript
authorizationStatus(capability: PKPassLibrary_Capability): PKPassLibrary_AuthorizationStatus
Swift declaration
func authorizationStatus(for capability: PKPassLibrary.Capability) -> PKPassLibrary.AuthorizationStatus
method · iOS 10.1+

canAddFelicaPass

TypeScript
canAddFelicaPass(): boolean
Swift declaration
func canAddFelicaPass() -> Bool
method · iOS 9.0+ · Deprecated in iOS 100000.0

canAddPaymentPass

TypeScript
canAddPaymentPass(primaryAccountIdentifier: string): boolean
Swift declaration
func canAddPaymentPass(withPrimaryAccountIdentifier primaryAccountIdentifier: String) -> Bool
method · iOS 13.4+

canAddSecureElementPass

TypeScript
canAddSecureElementPass(primaryAccountIdentifier: string): boolean
Swift declaration
func canAddSecureElementPass(primaryAccountIdentifier: String) -> Bool
method · iOS 6.0+

containsPass

TypeScript
containsPass(pass: PKPass): boolean
Swift declaration
func containsPass(_ pass: PKPass) -> Bool
method · iOS 16.0+

encryptedServiceProviderData

TypeScript
encryptedServiceProviderData(secureElementPass: PKSecureElementPass, completion: ((arg0: (NativeMap<unknown, unknown>) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func encryptedServiceProviderData(for secureElementPass: PKSecureElementPass) async throws -> [AnyHashable : Any]
init

init

TypeScript
static init(): PKPassLibrary
Swift declaration
init()
method · iOS 9.0+ · Deprecated in iOS 100000.0

isPaymentPassActivationAvailable

TypeScript
isPaymentPassActivationAvailable10337(): boolean
Swift declaration
func isPaymentPassActivationAvailable() -> Bool
method · iOS 8.3+

openPaymentSetup

TypeScript
openPaymentSetup(): void
Swift declaration
func openPaymentSetup()
method · iOS 26.4+

openPaymentSetup

TypeScript
openPaymentSetupMerchantIdentifier(merchantIdentifier: string): void
Swift declaration
func openPaymentSetup(merchantIdentifier: String)
method · iOS 6.0+

pass

TypeScript
pass(identifier: string, serialNumber: string): (PKPass) | null
Swift declaration
func pass(withPassTypeIdentifier identifier: String, serialNumber: String) -> PKPass?
method · iOS 6.0+

passes

TypeScript
passes(): Array<PKPass>
Swift declaration
func passes() -> [PKPass]
method · iOS 8.0+

passes

TypeScript
passesOf(passType: PKPassType): Array<PKPass>
Swift declaration
func passes(of passType: PKPassType) -> [PKPass]
method · iOS 6.0+

passes

TypeScript
passesWithReaderIdentifier(readerIdentifier: string): Array<PKSecureElementPass>
Swift declaration
func passes(withReaderIdentifier readerIdentifier: String) -> Set<PKSecureElementPass>
method · iOS 10.0+ · Deprecated in iOS 100000.0

present

TypeScript
present(pass: PKPaymentPass): void
Swift declaration
func present(_ pass: PKPaymentPass)
method · iOS 13.4+

present

TypeScript
present75366(pass: PKSecureElementPass): void
Swift declaration
func present(_ pass: PKSecureElementPass)
method · iOS 9.0+ · Deprecated in iOS 100000.0

remotePaymentPasses

TypeScript
remotePaymentPasses(): Array<PKPaymentPass>
Swift declaration
func remotePaymentPasses() -> [PKPaymentPass]
method · iOS 6.0+

removePass

TypeScript
removePass(pass: PKPass): void
Swift declaration
func removePass(_ pass: PKPass)
method · iOS 6.0+

replacePass

TypeScript
replacePass(pass: PKPass): boolean
Swift declaration
func replacePass(with pass: PKPass) -> Bool
method · iOS 26.0+

requestAuthorization

TypeScript
requestAuthorization(capability: PKPassLibrary_Capability, completion: ((arg0: PKPassLibrary_AuthorizationStatus) => void)): void
Swift declaration
func requestAuthorization(for capability: PKPassLibrary.Capability) async -> PKPassLibrary.AuthorizationStatus
method · iOS 15.0+

serviceProviderData

TypeScript
serviceProviderData(secureElementPass: PKSecureElementPass, completion: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
func serviceProviderData(for secureElementPass: PKSecureElementPass) async throws -> Data
method · iOS 13.4+ · Deprecated in iOS 26.0

sign

TypeScript
sign(signData: ArrayBuffer, secureElementPass: PKSecureElementPass, completion: ((arg0: (ArrayBuffer) | null, arg1: (ArrayBuffer) | null, arg2: (NativeError) | null) => void)): void
Swift declaration
func sign(_ signData: Data, using secureElementPass: PKSecureElementPass) async throws -> (Data, Data)
get · iOS 13.4+

remoteSecureElementPasses

TypeScript
get remoteSecureElementPasses(): Array<PKSecureElementPass>
Swift declaration
var remoteSecureElementPasses: [PKSecureElementPass] { get }
get · iOS 13.4+

isSecureElementPassActivationAvailable

TypeScript
get isSecureElementPassActivationAvailable(): boolean
Swift declaration
var isSecureElementPassActivationAvailable: Bool { get }

Skipped declarations

No declarations were skipped in this snapshot.

All PassKit types →