From dcd6aba9f68af437fcd975e741202ddef4241417 Mon Sep 17 00:00:00 2001 From: NachoSoto Date: Tue, 11 Jul 2023 08:46:48 -0700 Subject: [PATCH 1/3] `Trusted Entitlements`: improved documentation I've also added a link to our new documentation page: https://rev.cat/trusted-entitlements --- .../DocCDocumentation.docc/Purchases.md | 3 ++- Sources/Purchasing/Configuration.swift | 12 +++++++++--- Sources/Purchasing/EntitlementInfo.swift | 3 +++ Sources/Purchasing/EntitlementInfos.swift | 4 ++++ 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md b/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md index d08dad3399..5d08f0b36e 100644 --- a/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md +++ b/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md @@ -115,13 +115,14 @@ Most features require configuring the SDK before using it. - ``Purchases/setOnesignalID(_:)`` ### Advanced Configuration -- ``Purchases/finishTransactions`` +- ``Configuration/Builder/with(observerMode:)`` - ``Purchases/invalidateCustomerInfoCache()`` - ``Purchases/forceUniversalAppStore`` - ``Purchases/proxyURL`` - ``Purchases/verboseLogs`` - ``Purchases/verboseLogHandler`` - ``Purchases/allowSharingAppStoreAccount`` +- ``Configuration/Builder/with(entitlementVerificationMode:)`` ### Configuring the SDK with parameters (deprecated) - ``Purchases/configure(withAPIKey:appUserID:)`` diff --git a/Sources/Purchasing/Configuration.swift b/Sources/Purchasing/Configuration.swift index 0a01691102..c84326c29e 100644 --- a/Sources/Purchasing/Configuration.swift +++ b/Sources/Purchasing/Configuration.swift @@ -172,18 +172,21 @@ import Foundation } /// Set ``Configuration/EntitlementVerificationMode``. + /// /// Defaults to ``Configuration/EntitlementVerificationMode/disabled``. /// /// The result of the verification can be obtained from ``EntitlementInfos/verification`` or /// ``EntitlementInfo/verification``. - /// - /// - Note: This requires iOS 13+. - /// - Important: This feature is currently in beta. + /// + /// - Note: This feature requires iOS 13+. /// - Warning: When changing from ``Configuration/EntitlementVerificationMode/disabled`` /// to ``Configuration/EntitlementVerificationMode/informational`` /// the SDK will clear the ``CustomerInfo`` cache. /// This means that users will need to connect to the internet to get back their entitlements. /// + /// ### Related Articles + /// - [Documentation](https://rev.cat/trusted-entitlements) + /// /// ### Related Symbols /// - ``Configuration/EntitlementVerificationMode`` /// - ``VerificationResult`` @@ -222,6 +225,9 @@ extension Configuration { /// Defines how strict ``EntitlementInfo`` verification ought to be. /// + /// ### Related Articles + /// - [Documentation](https://rev.cat/trusted-entitlements) + /// /// ### Related Symbols /// - ``VerificationResult`` /// - ``Configuration/Builder/with(entitlementVerificationMode:)`` diff --git a/Sources/Purchasing/EntitlementInfo.swift b/Sources/Purchasing/EntitlementInfo.swift index 21f215e6a2..285d64d9bb 100644 --- a/Sources/Purchasing/EntitlementInfo.swift +++ b/Sources/Purchasing/EntitlementInfo.swift @@ -167,6 +167,9 @@ extension PeriodType: DefaultValueProvider { @objc public var ownershipType: PurchaseOwnershipType { self.contents.ownershipType } /// Whether this entitlement was verified. + /// + /// ### Related Articles + /// - [Documentation](https://rev.cat/trusted-entitlements) /// /// ### Related Symbols /// - ``VerificationResult`` diff --git a/Sources/Purchasing/EntitlementInfos.swift b/Sources/Purchasing/EntitlementInfos.swift index 07251efe56..42022e6089 100644 --- a/Sources/Purchasing/EntitlementInfos.swift +++ b/Sources/Purchasing/EntitlementInfos.swift @@ -32,6 +32,10 @@ import Foundation } /// Whether these entitlements were verified. + /// + /// ### Related Articles + /// - [Documentation](https://rev.cat/trusted-entitlements) + /// /// ### Related Symbols /// - ``VerificationResult`` @available(iOS 13.0, macOS 10.15, tvOS 13.0, watchOS 6.2, *) From 7d01aa323c73602606f2e223876ae2aa1158b8bc Mon Sep 17 00:00:00 2001 From: NachoSoto Date: Tue, 11 Jul 2023 08:49:02 -0700 Subject: [PATCH 2/3] One more --- Sources/Security/VerificationResult.swift | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Sources/Security/VerificationResult.swift b/Sources/Security/VerificationResult.swift index 2c19f2fd2f..40aa3ce254 100644 --- a/Sources/Security/VerificationResult.swift +++ b/Sources/Security/VerificationResult.swift @@ -36,6 +36,9 @@ import Foundation /// } /// ``` /// +/// ### Related Articles +/// - [Documentation](https://rev.cat/trusted-entitlements) +/// /// ### Related Symbols /// - ``Configuration/EntitlementVerificationMode`` /// - ``Configuration/Builder/with(entitlementVerificationMode:)`` From bf7bb62dc252d55ab37d7c9c8cb47b1718fa8c62 Mon Sep 17 00:00:00 2001 From: NachoSoto Date: Tue, 11 Jul 2023 08:51:19 -0700 Subject: [PATCH 3/3] Revert this --- Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md b/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md index 5d08f0b36e..9c5529bd45 100644 --- a/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md +++ b/Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md @@ -115,7 +115,7 @@ Most features require configuring the SDK before using it. - ``Purchases/setOnesignalID(_:)`` ### Advanced Configuration -- ``Configuration/Builder/with(observerMode:)`` +- ``Purchases/finishTransactions`` - ``Purchases/invalidateCustomerInfoCache()`` - ``Purchases/forceUniversalAppStore`` - ``Purchases/proxyURL``