Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылка платформы PassKit ссылка класса PKPassLibrary

Опции
Развертывание Target:

На этой странице
Язык:

PKPassLibrary

Наследование

Соответствует

Оператор импорта

Swift

import PassKit

Objective C

@import PassKit;

Доступность

Доступный в iOS 6.0 и позже.

PKPassLibrary класс предоставляет интерфейс библиотеке пользователя передач.

PKPassLibrary не ориентировано на многопотоковое исполнение. Используйте экземпляры этого класса только на единственном потоке.

Доступ к передачам
  • isPassLibraryAvailable () + isPassLibraryAvailable

    Указывает, доступна ли библиотека передачи.

    Объявление

    Swift

    class func isPassLibraryAvailable() -> Bool

    Objective C

    + (BOOL)isPassLibraryAvailable

    Возвращаемое значение

    YEStrue если библиотека передачи доступна; иначе, NOfalse.

    Обсуждение

    Этот метод предоставлен, потому что библиотека передачи может быть недоступной даже если PKPassLibrary класс существует.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

  • передачи () - передачи

    Возвращает передачи в библиотеке передачи пользователя, к которой приложение имеет доступ.

    Объявление

    Swift

    func passes() -> [AnyObject]!

    Objective C

    - (NSArray *)passes

    Возвращаемое значение

    Передачи в библиотеке передачи пользователя.

    Обсуждение

    Ваше приложение только имеет доступ к определенным передачам, на основе его прав. Передачи, к которым Ваше приложение не имеет доступа, не возвращаются.

    Упорядочивание передач не фиксируется; вызов этого метода многократно может возвратить те же передачи, но в различном порядке.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

  • passWithPassTypeIdentifier (_: serialNumber:) - passWithPassTypeIdentifier:serialNumber:

    Возвращает передачу с данным идентификатором типа передачи и порядковым номером.

    Объявление

    Swift

    func passWithPassTypeIdentifier(_ identifier: String!, serialNumber serialNumber: String!) -> PKPass!

    Objective C

    - (PKPass *)passWithPassTypeIdentifier:(NSString *)identifier serialNumber:(NSString *)serialNumber

    Параметры

    identifier

    Идентификатор типа передачи передачи.

    serialNumber

    Порядковый номер передачи.

    Возвращаемое значение

    Передача с данным идентификатором типа передачи и порядковым номером, или nil если приложение не имеет надлежащего права, если нет такой передачи или.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

  • passesOfType (_:) - passesOfType:

    Возвращает передачи указанного типа передачи.

    Объявление

    Swift

    func passesOfType(_ passType: PKPassType) -> [AnyObject]!

    Objective C

    - (NSArray *)passesOfType:(PKPassType)passType

    Параметры

    passType

    Одна из передачи вводит PKPassType.

    Возвращаемое значение

    Массив передач указанного типа.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 8.0 и позже.

Работа с передачами
  • addPasses (_: withCompletionHandler:) - addPasses:withCompletionHandler:

    Легкий вес подарков UI для добавления многократных передач сразу.

    Объявление

    Swift

    func addPasses(_ passes: [AnyObject]!, withCompletionHandler completion: ((PKPassLibraryAddPassesStatus) -> Void)!)

    Objective C

    - (void)addPasses:(NSArray *)passes withCompletionHandler:(void (^)(PKPassLibraryAddPassesStatus status))completion

    Параметры

    passes

    Добавляемые передачи.

    completion

    Блок завершения, вызванный после пользователя, выбирает действие. Этот блок берет следующие параметры:

    status

    Указывает, были ли добавлены передачи. Если пользователь выбирает для рассмотрения передач, это состояние установлено в PKPassLibraryShouldReviewPasses. В этом случае необходимо представить экземпляр PKAddPassesViewController позволить отзыву пользователя и добавить передачи.

    Обсуждение

    Используйте этот метод, когда пользователь уже указал к Вашему приложению, которое передачи должны быть добавлены к Сберкнижке — например, путем выбора из списка. Пользователя просят подтвердить действие, но не показывают каждую отдельную добавляемую передачу. Если Вы хотите позволить отзыву пользователя и выбрать отдельные передачи из массива передач, используйте экземпляр PKAddPassesViewController вместо этого.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 7.0 и позже.

  • containsPass (_:) - containsPass:

    Указывает, содержит ли библиотека передачи пользователя указанную передачу.

    Объявление

    Swift

    func containsPass(_ pass: PKPass!) -> Bool

    Objective C

    - (BOOL)containsPass:(PKPass *)pass

    Параметры

    pass

    Запрашиваемая передача.

    Возвращаемое значение

    YEStrue если библиотека передачи пользователя содержит передачу; иначе, NOfalse.

    Обсуждение

    Этот метод позволяет Вам решить, что библиотека передачи содержит передачу даже при том, что Ваше приложение не было бы в состоянии считать или изменить передачу. Например, почтовый клиент не имел бы прав в чтение или записал бы любые передачи из библиотеки.

    Ваше приложение может использовать этот метод для обеспечения UI, указывающего, является ли передача уже в библиотеке.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

  • removePass (_:) - removePass:

    Удаляет передачу из библиотеки передачи пользователя.

    Объявление

    Swift

    func removePass(_ pass: PKPass!)

    Objective C

    - (void)removePass:(PKPass *)pass

    Параметры

    pass

    Удаляемая передача.

    Обсуждение

    Если Ваше приложение не имеет надлежащего права, этот метод ничего не делает.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

  • replacePassWithPass (_:) - replacePassWithPass:

    Заменяет передачу в библиотеке передачи пользователя с данной передачей.

    Объявление

    Swift

    func replacePassWithPass(_ pass: PKPass!) -> Bool

    Objective C

    - (BOOL)replacePassWithPass:(PKPass *)pass

    Параметры

    pass

    Новая передача.

    Возвращаемое значение

    YEStrue если передача была заменена успешно; иначе NOfalse.

    Обсуждение

    Новая передача заменяет существующую передачу тем же идентификатором типа передачи и порядковым номером. Если нет такой передачи в библиотеке передачи пользователя, заменяющих сбоях.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.

Активация передач платежа
  • activatePaymentPass (_: withActivationCode:completion:) - activatePaymentPass:withActivationCode:completion:

    Активирует передачу платежа с помощью предоставленного кода активации.

    Объявление

    Swift

    func activatePaymentPass(_ paymentPass: PKPaymentPass!, withActivationCode activationCode: String!, completion completion: ((Bool, NSError!) -> Void)!)

    Objective C

    - (void)activatePaymentPass:(PKPaymentPass *)paymentPass withActivationCode:(NSString *)activationCode completion:(void (^)(BOOL success, NSError *error))completion

    Параметры

    paymentPass

    Активируемая передача платежа.

    activationCode

    Код активации.

    completion

    Блок завершения, вызванный после активации.

    Этот блок берет следующие параметры:

    success

    YEStrue если была авторизована передача; иначе NOfalse.

    error

    Если success NOfalse, описание ошибки.

    Обсуждение

    Передача должна уже быть настроена, и это должно в настоящее время быть в PKPaymentPassActivationStateRequiresActivation состояние.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • activatePaymentPass (_: withActivationData:completion:) - activatePaymentPass:withActivationData:completion:

    Активирует передачу платежа с помощью предоставленного кода активации.

    Объявление

    Swift

    func activatePaymentPass(_ paymentPass: PKPaymentPass!, withActivationData activationData: NSData!, completion completion: ((Bool, NSError!) -> Void)!)

    Objective C

    - (void)activatePaymentPass:(PKPaymentPass *)paymentPass withActivationData:(NSData *)activationData completion:(void (^)(BOOL success, NSError *error))completion

    Параметры

    paymentPass

    Активируемая передача платежа.

    activationData

    Криптографический одноразовый пароль.

    Эти данные являются закодированным Base64 и затем отправленным в платежную систему. Платформа обрабатывает это как непрозрачное значение.

    completion

    Блок завершения, вызванный после активации.

    Этот блок берет следующие параметры:

    success

    YEStrue если была авторизована передача; иначе NOfalse.

    error

    Если success NOfalse, описание ошибки.

    Обсуждение

    Передача должна уже быть настроена, и это должно в настоящее время быть в PKPaymentPassActivationStateRequiresActivation состояние.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • isPaymentPassActivationAvailable () + isPaymentPassActivationAvailable

    Указывает, передают ли поддержки устройства, добавляющие платеж.

    Объявление

    Swift

    class func isPaymentPassActivationAvailable() -> Bool

    Objective C

    + (BOOL)isPaymentPassActivationAvailable

    Возвращаемое значение

    YEStrue если поддержки устройства, добавляющие передачи платежа; иначе, NOfalse.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 8.0 и позже.

  • openPaymentSetup () - openPaymentSetup

    Открывает пользовательский интерфейс для установки кредитных карт для Оплаты Apple.

    Объявление

    Swift

    func openPaymentSetup()

    Objective C

    - (void)openPaymentSetup

    Обсуждение

    Используйте этот метод для перемещения пользователей в интерфейс для добавления кредитных карт. Этот метод передаст управление приложению Сберкнижки на iPhone или приложению Настроек на iPad. На устройствах, не поддерживающих Оплату Apple, этот метод ничего не делает.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 8.3 и позже.

Константы
  • Ключи уведомления

    Ключи раньше получали значения из словаря информации о пользователе уведомлений библиотеки передачи.

    Объявление

    Swift

    let PKPassLibraryAddedPassesUserInfoKey: String let PKPassLibraryRemovedPassInfosUserInfoKey: String let PKPassLibraryReplacementPassesUserInfoKey: String let PKPassLibraryPassTypeIdentifierUserInfoKey: String let PKPassLibrarySerialNumberUserInfoKey: String

    Objective C

    NSString * const PKPassLibraryAddedPassesUserInfoKey; NSString * const PKPassLibraryRemovedPassInfosUserInfoKey; NSString * const PKPassLibraryReplacementPassesUserInfoKey; NSString * const PKPassLibraryPassTypeIdentifierUserInfoKey; NSString * const PKPassLibrarySerialNumberUserInfoKey;

    Константы

    • PKPassLibraryAddedPassesUserInfoKey

      Массив PKPass добавленные объекты.

      Доступный в iOS 6.0 и позже.

    • PKPassLibraryRemovedPassInfosUserInfoKey

      Массив словарей, описывающих удаленные передачи.

      Словарь содержит ключи PKPassLibraryPassTypeIdentifierUserInfoKey и PKPassLibrarySerialNumberUserInfoKey.

      Доступный в iOS 6.0 и позже.

    • PKPassLibraryReplacementPassesUserInfoKey

      Массив PKPass замененные объекты.

      Доступный в iOS 6.0 и позже.

    • PKPassLibraryPassTypeIdentifierUserInfoKey

      Идентификатор типа передачи передачи.

      Используемый словарем, который является значением PKPassLibraryRemovedPassInfosUserInfoKey.

      Доступный в iOS 6.0 и позже.

    • PKPassLibrarySerialNumberUserInfoKey

      Порядковый номер передачи.

      Используемый словарем, который является значением PKPassLibraryRemovedPassInfosUserInfoKey.

      Доступный в iOS 6.0 и позже.

  • PKPassLibraryAddPassesStatus

    Состояния, используемые при добавлении передач в библиотеку передачи.

    Объявление

    Swift

    enum PKPassLibraryAddPassesStatus : Int { case DidAddPasses case ShouldReviewPasses case DidCancelAddPasses }

    Objective C

    typedef enum : NSInteger { PKPassLibraryDidAddPasses, PKPassLibraryShouldReviewPasses, PKPassLibraryDidCancelAddPasses, } PKPassLibraryAddPassesStatus;

    Константы

    • DidAddPasses

      PKPassLibraryDidAddPasses

      Когда передачи были успешно добавлены, состояние использовало.

      Доступный в iOS 7.0 и позже.

    • ShouldReviewPasses

      PKPassLibraryShouldReviewPasses

      Когда приложение должно вывести на экран UI для разрешения отзыву пользователя передачи, состояние использовало.

      Доступный в iOS 7.0 и позже.

    • DidCancelAddPasses

      PKPassLibraryDidCancelAddPasses

      Состояние, используемое, когда пользователь отменил и передачи, не было добавлено.

      Доступный в iOS 7.0 и позже.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 7.0 и позже.

Уведомления
  • PKPassLibraryDidChangeNotification PKPassLibraryDidChangeNotification

    Отправленный после того, как библиотека передачи была изменена.

    Уведомление отправляется экземпляром PKPassLibrary класс. Если нет никаких экземпляров класса, уведомления не отправляются. Уведомление может быть отправлено на любом потоке или рабочем списке.

    Пользовательский информационный словарь уведомления описывает изменение. Посмотрите Notification Keys для используемых ключей.

    Оператор импорта

    Objective C

    @import PassKit;

    Swift

    import PassKit

    Доступность

    Доступный в iOS 6.0 и позже.