Class: PKPassLibrary

Inherits:
NSObject show all

Overview

The PKPassLibrary class provides an interface to the user’s library of passes.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Class Method Details

+ (Boolean) isPassLibraryAvailable

Returns whether the pass library is available. This method is provided because the pass library may be unavailable even if the PKPassLibrary class exists.

Returns:

  • (Boolean)

    YES if the pass library is available; otherwise, NO.

Instance Method Details

- (Boolean) containsPass(pass)

Returns whether the user’s pass library contains a pass. This method lets you determine that the pass library contains a pass even though your app wouldn’t be able to read or modify the pass. For example, an email client would not have entitlements to read or write any passes from the library.Your app can use this method to provide UI indicating whether a pass is already in the library.

Parameters:

  • pass (PKPass)

    The pass being queried.

Returns:

  • (Boolean)

    YES if the user’s pass library contains the pass; otherwise, NO.

- (Array) passes

Returns the passes in the user’s pass library Your app only has access to certain passes, based on its entitlements. Passes that your app doesn’t have access to are not returned.

Returns:

  • (Array)

    The passes in the user’s pass library.

- (PKPass) passWithPassTypeIdentifier(identifierserialNumber)

Returns the pass with the given pass type identifier and serial number.

Parameters:

  • identifier (String)

    The pass’s pass type identifier.

  • serialNumber (String)

    The pass’s serial number.

Returns:

  • (PKPass)

    The pass with the given pass type identifier and serial number, or nil if there is no such pass doesn’t have the appropriate entitlement.

- (Object) removePass(pass)

Removes the pass from the user’s pass library. This method does nothing if your app doesn’t have the appropriate entitlement.

Parameters:

  • pass (PKPass)

    The pass being removed.

Returns:

- (Boolean) replacePassWithPass(pass)

Replaces a pass in the user’s pass library with the given pass. The new pass replaces the existing pass with the same pass type identifier and serial number. If there is no such pass in the user’s pass library, the replacement fails.

Parameters:

  • pass (PKPass)

    The new pass.

Returns:

  • (Boolean)

    YES if the pass was replaced successfully; otherwise NO.