Миграция iOS SDK Adapty на v4.3 и v4.4

Чтобы обновить приложение с Adapty iOS SDK 4.1 или 4.2 до 4.4, примените все изменения из этого руководства. Если приложение уже использует 4.3, примените только изменения из v4.4. Приложение на 4.0 сначала требует изменений v4.1.

Warning

Формат резервного файла изменился в версии 4.4, и компилятор не может обнаружить устаревший файл. Без нового резервного файла каждый плейсмент лишится своего резервного пейвола.

Краткий справочник

ДоПослеВерсия
localizedPrice и currencyCode могут быть nilОба свойства всегда возвращают строку4.3.0
Код ошибки billingPlanUnavailable отсутствуетAdaptyError.ErrorCode включает billingPlanUnavailable4.3.0
Adapty.reportTransaction принимает TransactionAdapty.reportTransaction принимает VerificationResult<Transaction>; перегрузка с Transaction устарела4.3.2
case let .custom(id)case let .custom(id, _)4.4.0
AdaptyUICustomAssetAdaptyUIAsset; AdaptyCustomAsset остался без изменений4.4.0
.color(.uiColor(x)) и .color(.swiftUIColor(c)).color(Color(uiColor: x)) и .color(c)4.4.0
AdaptyUICustomFontAsset(font:defaultColor:defaultLetterSpacing:defaultLineHeight:)AdaptyUIFontAsset(font:color:letterSpacing:lineHeight:)4.4.0
Data assets отсутствуютAdaptyUIAsset включает .data для data assets4.4.0
AdaptyProduct.localizedBillingPeriodsubscriptionPricingTerms?.localizedBillingPeriod4.4.0
Резервный файл для версий 4.1–4.3Новый формат резервного файла; скачайте файл заново4.4.0

Изменения в v4.3

localizedPrice и currencyCode больше не опциональны

В версии 4.3 свойства localizedPrice и currencyCode объектов AdaptyPaywallProduct и AdaptySubscriptionOffer всегда возвращают строку, никогда nil. Код, который проверяет их на nil с помощью if let, guard let или ?., не компилируется. Удалите эти проверки:

- if let price = product.localizedPrice {
-     priceLabel.text = price
- }
+ priceLabel.text = product.localizedPrice

Также удалите значения по умолчанию ?? для этих свойств: они компилируются, но с предупреждением.

AdaptyError.ErrorCode включает billingPlanUnavailable

В версии 4.3 добавлен код ошибки billingPlanUnavailable. Оператор switch, перечисляющий все коды ошибок без ветки default, перестаёт компилироваться. Чтобы это исправить, добавьте ветку case .billingPlanUnavailable или ветку default.

Перегрузка Transaction метода reportTransaction устарела

В версии 4.3.2 перегрузка Adapty.reportTransaction(_:withVariationId:), принимающая простой Transaction без подписи App Store, выдаёт предупреждение об устаревании. Чтобы передать транзакцию вместе с её подписью App Store, используйте VerificationResult<Transaction>, который возвращает StoreKit:

- try await Adapty.reportTransaction(transaction, withVariationId: variationId)
+ try await Adapty.reportTransaction(verificationResult, withVariationId: variationId)

Изменения в v4.4

AdaptyUI.Action.custom содержит два значения

Когда пользователь нажимает кнопку с пользовательским действием, приложение получает AdaptyUI.Action.custom. В версии 4.4 оно содержит второе значение, arguments, после идентификатора действия. В замыкании didPerformAction и методе делегата flowController(_:didPerform:) добавьте _ для этого второго значения:

  switch action {
- case let .custom(id):
+ case let .custom(id, _):
      if id == "openNewPaywall" {
          // Display another flow or paywall
      }
  default:
      break
  }
switch action.id {
case .system(let systemAction):
    return handleSystemAction(systemAction)
case .custom(let id, _):
    if id == "action_restore" {
        return handleRestore()
    }
    if id == "action_terms" {
        return handleTerms()
    }
    if id == "action_privacy" {
        return handlePrivacy()
    }
}

Пользовательские ассеты

В версии 4.4 AdaptyUICustomAsset переименован в AdaptyUIAsset. Старое название вызывает предупреждение об устаревании.

Ассеты цветов, шрифтов и данных изменились в трёх аспектах:

  • Ассеты цветов: .color принимает SwiftUI Color. AdaptyUICustomColorAsset удалён. Оберните UIColor в Color(uiColor:) и передавайте SwiftUI Color напрямую:

    - "brand_color": .color(.uiColor(brandColor)),
    + "brand_color": .color(Color(uiColor: brandColor)),
  • Шрифтовые ресурсы: AdaptyUIFontAsset принимает color:, letterSpacing: и lineHeight: вместо defaultColor:, defaultLetterSpacing: и defaultLineHeight:. Параметр color: принимает SwiftUI Color:

    - "title_font": .font(AdaptyUICustomFontAsset(font: titleFont, defaultColor: .uiColor(.white), defaultLineHeight: 24)),
    + "title_font": .font(AdaptyUIFontAsset(font: titleFont, color: .white, lineHeight: 24)),
  • Ресурсы данных: в AdaptyUIAsset добавлен новый тип ресурса — .data. switch-оператор, перечисляющий все типы ресурсов без ветки default, перестаёт компилироваться. Только кастомные элементы читают ресурсы данных, поэтому новая ветка может быть пустой: case .data: break.

AdaptyProduct.localizedBillingPeriod устарел

У AdaptyProduct есть свойство subscriptionPricingTerms, которое описывает каждый платёж по продукту: его стоимость и периодичность списания. В версии 4.4 localizedBillingPeriod — текст, показывающий периодичность оплаты, — перемещается из AdaptyProduct в subscriptionPricingTerms. AdaptyProduct.localizedBillingPeriod по-прежнему работает, но теперь выдаёт предупреждение об устаревании: оно возвращает subscriptionPricingTerms?.localizedBillingPeriod. Чтобы убрать предупреждение, читайте свойство через pricing terms:

- let period = product.localizedBillingPeriod
+ let period = product.subscriptionPricingTerms?.localizedBillingPeriod

Резервные файлы

Формат резервного файла изменился в SDK 4.4. Скачайте файл заново в Placements > Fallbacks, выберите Adapty SDK v4.4.0 and higher и добавьте его в приложение.

Скачанный файл называется ios_4_4_0_fallback.json. Дайте ему имя, которое ваше приложение передаёт в Bundle.main.url(forResource:withExtension:), или обновите это имя в вызове.

Warning

Устаревший файл резервных пейволов не вызывает ошибки компиляции. Каждый плейсмент просто перестаёт получать резервный пейвол. SDK при этом выводит в лог: «The fallback paywalls version is not correct. Download a new one from the Adapty Dashboard.»