Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Trusted Entitlements: improved documentation #2782

Merged
merged 3 commits into from
Jul 11, 2023
Merged

Trusted Entitlements: improved documentation #2782

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dcd6aba
`Trusted Entitlements`: improved documentation
NachoSoto Jul 11, 2023
7d01aa3
One more
NachoSoto Jul 11, 2023
bf7bb62
Revert this
NachoSoto Jul 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Sources/DocCDocumentation/DocCDocumentation.docc/Purchases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,14 @@ Most features require configuring the SDK before using it.
- ``Purchases/setOnesignalID(_:)``

### Advanced Configuration
- ``Purchases/finishTransactions``
NachoSoto marked this conversation as resolved.
Show resolved Hide resolved
- ``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:)``
Expand Down
12 changes: 9 additions & 3 deletions Sources/Purchasing/Configuration.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also removed this.

///
/// - 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``
Expand Down Expand Up @@ -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:)``
Expand Down
3 changes: 3 additions & 0 deletions Sources/Purchasing/EntitlementInfo.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down
4 changes: 4 additions & 0 deletions Sources/Purchasing/EntitlementInfos.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, *)
Expand Down
3 changes: 3 additions & 0 deletions Sources/Security/VerificationResult.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ import Foundation
/// }
/// ```
///
/// ### Related Articles
/// - [Documentation](https://rev.cat/trusted-entitlements)
///
/// ### Related Symbols
/// - ``Configuration/EntitlementVerificationMode``
/// - ``Configuration/Builder/with(entitlementVerificationMode:)``
Expand Down