### Binary License Case Example
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensesource/binary
Demonstrates the basic syntax for referencing the 'binary' case within the LicenseSource.binary context. This is a foundational example for working with binary license types.
```swift
case binary
```
--------------------------------
### Staging Case Example
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseenvironment/staging
Demonstrates the 'staging' case within the LicenseEnvironment.
```swift
case staging
```
--------------------------------
### LicenseKit Case Example
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensesource/licensekit
Demonstrates the 'licensekit' case in LicenseSource.licensekit.
```swift
case licensekit
```
--------------------------------
### LicenseSource.file Case Example
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensesource/file
Demonstrates the basic 'case file' usage for LicenseSource.file.
```swift
case file
```
--------------------------------
### Setup Binary License Engine
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/understanding-services
Set up a License Engine using binary licenses. This involves creating a collection of License objects and providing it to the engine.
```swift
extension Collection where Element == License {
static var myLicenses: [LicenseCustomer] {
[.basicLicense, .extensiveLicense]
}
}
let engine = try await LicenseEngine(
licenseKey: "your-licensekit-license-key"
) {
.binary(licenses: .myLicenses)
}
```
--------------------------------
### Create a LicenseStore Instance
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensestore/init%28%29
Call the init() function to create a new instance of the LicenseStore. This is the primary way to get a store object for managing licenses.
```javascript
init()
```
--------------------------------
### Get All Standard Environments
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseenvironment/all
Retrieves all predefined standard environments. This is a static property and can be accessed directly on the `LicenseEnvironment` type.
```swift
static var all: [`Self`] { get }
```
--------------------------------
### Install LicenseKit with Swift Package Manager
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit
Add LicenseKit to your project using the Swift Package Manager by specifying the repository URL.
```swift
https://github.com/Kankoda/LicenseKit.git
```
--------------------------------
### alignmentGuide(_:computeValue:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensemanagerapp/alignmentguide%28_%3Acomputevalue%3A%29-50cyj
This instance method allows for custom alignment guides in SwiftUI views. It takes a VerticalAlignment and a closure to compute the alignment value based on view dimensions.
```APIDOC
## alignmentGuide(_:computeValue:)
### Description
This instance method allows for custom alignment guides in SwiftUI views. It takes a `VerticalAlignment` and a closure to compute the alignment value based on view dimensions.
### Method Signature
```swift
@preconcurrency nonisolated func alignmentGuide(
_ g: VerticalAlignment,
computeValue: @escaping (ViewDimensions) -> CGFloat
) -> some View
```
### Parameters
#### Path Parameters
- **g** (`VerticalAlignment`) - The vertical alignment guide to use.
- **computeValue** (`(ViewDimensions) -> CGFloat`) - A closure that computes the alignment value based on the view's dimensions. This closure is executed when the alignment guide's value is needed.
### Return Value
Returns `some View`, which is a view that incorporates the specified alignment guide.
```
--------------------------------
### Alignment Guide
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensekeygeneratorscreen/view-implementations
Defines a custom alignment guide for a view, allowing for more precise layout control.
```swift
func alignmentGuide(_ guide: VerticalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
```swift
func alignmentGuide(_ guide: HorizontalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
--------------------------------
### alignmentGuide(_:computeValue:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/alignmentguide%28_%3Acomputevalue%3A%29-4ddbe
Creates a custom alignment guide for a view. This method allows for defining how a view aligns itself relative to other views in a layout, based on a computed value.
```APIDOC
## alignmentGuide(_:computeValue:)
### Description
Creates a custom alignment guide for a view. This method allows for defining how a view aligns itself relative to other views in a layout, based on a computed value.
### Method Signature
```swift
@preconcurrency nonisolated
func alignmentGuide(
_ g: VerticalAlignment,
computeValue: @escaping (ViewDimensions) -> CGFloat
) -> some View
```
### Parameters
- **g** (VerticalAlignment) - The vertical alignment guide to use.
- **computeValue** (@escaping (ViewDimensions) -> CGFloat) - A closure that computes the alignment value based on the view's dimensions.
```
--------------------------------
### Alignment Guide Modifier
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinfoview/view-implementations
Defines a custom alignment guide for a view, allowing for more precise layout control.
```swift
func alignmentGuide(_ alignment: HorizontalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
```swift
func alignmentGuide(_ alignment: VerticalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
--------------------------------
### Alignment Guide Modifiers
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinfosection/view-implementations
These methods define custom alignment guides for views, allowing for more precise layout control based on horizontal or vertical alignment.
```swift
func alignmentGuide(_: HorizontalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
```swift
func alignmentGuide(_: VerticalAlignment, computeValue: @escaping (ViewDimensions) -> CGFloat) -> some View
```
--------------------------------
### Setup Cached License Service
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/understanding-services
Configure a cached license service to store and retrieve license validations. This allows users to continue using the software even when offline.
```swift
let engine = try await LicenseEngine(
licenseKey: "your-licensekit-license-key"
) {
.cached(
service: .gumroad(...)
)
}
```
--------------------------------
### current
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseplatform/current
Gets the current platform instance of LicensePlatform.
```APIDOC
## current
### Description
Gets the current platform instance of LicensePlatform.
### Property
`static var current: LicensePlatform { get }`
```
--------------------------------
### init(licenseKey:productBundle:licenseStore:licenseService:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseengine/init%28licensekey%3Aproductbundle%3Alicensestore%3Alicenseservice%3A%29
Initializes a LicenseEngine instance. This initializer attempts to create a license engine using the provided license key, product bundle, an optional license store, and a service builder function. If the license key is valid, it returns an engine instance configured with the preferred service.
```APIDOC
## init(licenseKey:productBundle:licenseStore:licenseService:)
### Description
Initializes a LicenseEngine instance. This initializer attempts to create a license engine using the provided license key, product bundle, an optional license store, and a service builder function. If the license key is valid, it returns an engine instance configured with the preferred service.
### Method
`convenience init`
### Parameters
#### Path Parameters
- **licenseKey** (String) - Required - The license key to use.
- **productBundle** (Bundle) - Optional - Defaults to `.main`. The bundle of the product that uses LicenseKit.
- **licenseStore** (LicenseStore?) - Optional - A store to store the last fetched license in, in any.
- **licenseService** (@escaping ServiceBuilder) - Required - A function that creates a license service with the resolved license.
### Discussion
If the license key is valid, an engine instance will be returned with the preferred service configuration.
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/help%28_%3A%29-6mc6q
This instance method is inherited from the `View` protocol and is available on `LicenseApp.LicenseFileDecryptionScreen`. It is used to display help text associated with the view.
```APIDOC
## help(_:)
### Description
Displays help text associated with the view. This method is inherited from the `View` protocol.
### Method Signature
`nonisolated func help(_ text: Text) -> some View`
### Parameters
* **text** (Text) - The help text to display.
```
--------------------------------
### Setup Encrypted License File Service
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/understanding-services
Configures the LicenseEngine to use an encrypted license file. It specifies the file name, extension, and a custom license file generator for decryption and parsing.
```swift
let engine = try await LicenseEngine(
licenseKey: "your-licensekit-license-key"
) { engineLicense in
.licenseFile(
fileName: "MyLibrary",
fileExtension: "license",
generator: .myLicenseFileGenerator
)
}
```
--------------------------------
### LicenseStore Initializers
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensestore
Provides documentation for initializing a LicenseStore instance.
```APIDOC
## Initializers
### `init()`
Create a store.
```
--------------------------------
### init(name:fullName:contact:address:email:phone:website:additionalInfo:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensecustomer/init%28name%3Afullname%3Acontact%3Aaddress%3Aemail%3Aphone%3Awebsite%3Aadditionalinfo%3A%29
Creates a new license customer instance with the provided details. This initializer allows for comprehensive customer information to be stored.
```APIDOC
## init(name:fullName:contact:address:email:phone:website:additionalInfo:)
### Description
Creates a new license customer instance.
### Method
Initializer
### Parameters
#### Path Parameters
* **name** (String) - Required - The name of the customer.
* **fullName** (String?) - Optional - The full customer name.
* **contact** (String?) - Optional - The customer’s contact person, if any.
* **address** (String?) - Optional - The customer address, if any.
* **email** (String?) - Optional - The customer e-mail, if any.
* **phone** (String?) - Optional - The customer phone number, if any.
* **website** (String?) - Optional - The customer website, if any.
* **additionalInfo** ([String : String]) - Optional - Additional customer information, if any.
```
--------------------------------
### Accessing displayName
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license/validationerror/displayname
Get the display name of a validation error. This property is read-only.
```swift
var displayName: String { get }
```
--------------------------------
### Get Current LicensePlatform
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseplatform/current
Retrieves the singleton instance of the current LicensePlatform. This is a static property.
```swift
static var current: LicensePlatform { get }
```
--------------------------------
### init(_:_:_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/init%28_%3A_%3A_%3A%29-19vqq
Initializes a LicenseInfoRow with a localized title, a string value, and an optional color.
```APIDOC
## init(_:_:_:)
### Description
Initializes a new instance of `LicenseInfoRow` with a localized title, a string value, and an optional color.
### Parameters
#### Initializer Parameters
- **title** (LocalizedStringKey) - The localized title for the row.
- **value** (String?) - The string value to display in the row. This can be nil.
- **color** (Color?) - An optional color for the row. Defaults to nil.
```
--------------------------------
### Layout and Animation Modifiers
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinfoview/view-implementations
Methods for controlling layout guides, aspect ratio, animations, and background properties.
```APIDOC
## Instance Methods
`func alignmentGuide(HorizontalAlignment, computeValue: (ViewDimensions) -> CGFloat) -> some View`
### Description
Defines a horizontal alignment guide.
`func alignmentGuide(VerticalAlignment, computeValue: (ViewDimensions) -> CGFloat) -> some View`
### Description
Defines a vertical alignment guide.
`func allowedDynamicRange(Image.DynamicRange?) -> some View`
### Description
Sets the allowed dynamic range for images.
`func allowsHitTesting(Bool) -> some View`
### Description
Controls whether the view allows hit testing.
`func allowsTightening(Bool) -> some View`
### Description
Controls whether the view allows tightening.
`func allowsWindowActivationEvents() -> some View`
### Description
Enables window activation events.
`func allowsWindowActivationEvents(Bool?) -> some View`
### Description
Enables or disables window activation events with an optional boolean.
`func anchorPreference(key: K.Type, value: Anchor.Source, transform: (Anchor) -> K.Value) -> some View`
### Description
Sets an anchor preference with a key, source, and transform.
`func animation(Animation?) -> some View`
### Description
Applies a default animation.
`func animation(Animation?, value: V) -> some View`
### Description
Applies an animation based on a value.
`func aspectRatio(CGSize, contentMode: ContentMode) -> some View`
### Description
Sets the aspect ratio of the view with a CGSize and content mode.
`func aspectRatio(CGFloat?, contentMode: ContentMode) -> some View`
### Description
Sets the aspect ratio of the view with a CGFloat and content mode.
`func assistiveAccessNavigationIcon(Image) -> some View`
### Description
Sets a custom image for assistive access navigation.
`func assistiveAccessNavigationIcon(systemImage: String) -> some View`
### Description
Sets a system image for assistive access navigation.
`func attributedTextFormattingDefinition(D) -> some View`
### Description
Defines attributed text formatting.
`func attributedTextFormattingDefinition(S.Type) -> some View`
### Description
Defines attributed text formatting using a type.
`func attributedTextFormattingDefinition(KeyPath) -> some View`
### Description
Defines attributed text formatting using a KeyPath.
`func autocapitalization(UITextAutocapitalizationType) -> some View`
### Description
Sets the autocapitalization type.
`func autocorrectionDisabled(Bool) -> some View`
### Description
Disables autocorrection.
`func background(Background, alignment: Alignment) -> some View`
### Description
Sets a background view with an alignment.
`func background(S, ignoresSafeAreaEdges: Edge.Set) -> some View`
### Description
Sets a background view, ignoring specified safe area edges.
```
--------------------------------
### Create and Use a License Store
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/getting-started-article
Implement a LicenseStore to manage the current user license and inject it into the LicenseEngine for automatic storage.
```swift
let store = try LicenseStore(licenseKey: "YOUR_LICENSE_KEY")
let engine = try LicenseEngine(licenseKey: "YOUR_LICENSE_KEY",
licenseServiceTypes: [CompiledLicenseServiceType()],
licenseStore: store)
```
--------------------------------
### Get Activation Date from Purchase
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseintegrations/gumroad/purchase/activationdate
Access the activation date of a Gumroad purchase. This property is optional and returns a `Date?`.
```swift
var activationDate: Date? { get }
```
--------------------------------
### Get License
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseengine
Retrieves a customer license using a provided key. This method is available after the engine has been successfully initialized.
```APIDOC
## getLicense(withKey: String) async throws -> License
### Description
Try to register a license key for your product and retrieve the corresponding license object. This method allows you to fetch customer licenses using the configured service.
### Parameters
#### Path Parameters
- **withKey** (String) - Required - The key to identify the customer license.
### Response
#### Success Response (200)
- **License** - Represents the retrieved software license.
```
--------------------------------
### LicenseKit Initializer Parameters
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license/init%28licensekey%3Aname%3Asource%3Acustomer%3Atier%3Aactivationdate%3Abillingdate%3Arenewaldate%3Aexpirationdate%3Aexpirationproductversion%3Aallowsexpiration%3Arenewalprice%3Abundleids%3Aplatforms%3Aenvironments%3Afeatures%3Afeatureids%3Aadditionalinfo%3A%29
Defines the parameters for creating a new license instance. Includes license key, optional customer and product details, dates, pricing, and platform/feature restrictions.
```swift
init(
licenseKey: String,
name: String? = nil,
source: LicenseSource? = nil,
customer: LicenseCustomer? = nil,
tier: LicenseTier = .standard,
activationDate: Date? = nil,
billingDate: Date? = nil,
renewalDate: Date? = nil,
expirationDate: Date? = nil,
expirationProductVersion: Double? = nil,
allowsExpiration: Bool = false,
renewalPrice: Double? = nil,
bundleIds: [String] = [],
platforms: [LicensePlatform] = .all,
environments: [LicenseEnvironment] = .all,
features: [any LicenseFeature] = [],
featureIds: [String] = [],
additionalInfo: [String : String] = [:]
)
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseservicescreen/help%28_%3A%29-2qrws
This instance method is inherited from the `View` protocol and is used to display help text within the LicenseApp.LicenseServiceScreen. It is available on iOS, iPadOS, Mac Catalyst, macOS, tvOS, and watchOS.
```APIDOC
## help(_:)
### Description
Displays help text within the view. This method is inherited from the `View` protocol.
### Method Signature
```swift
nonisolated func help(_ text: Text) -> some View
```
### Parameters
#### Path Parameters
- **text** (Text) - The help text to display.
```
--------------------------------
### Get Current License from Store
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license/current%28in%3A%29
Retrieves the license stored within a `LicenseStore`. Returns `nil` if no license is found.
```swift
static func current(in store: LicenseStore) -> License?
```
--------------------------------
### init(service:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseservicescreen/init%28service%3A%29
Initializes the LicenseServiceScreen. This initializer is marked with @MainActor, indicating it should be called on the main thread.
```APIDOC
## init(service:)
### Description
Initializes the LicenseServiceScreen with a specific license service.
### Method
`init` (Initializer)
### Parameters
#### Initializer Parameters
- **service** (`LicenseServiceType`) - Description not provided in source. This parameter is required.
### Notes
- This initializer is marked with `@MainActor`, meaning it must be called on the main thread.
```
--------------------------------
### LicenseEngine Initialization
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseengine
Initializes a LicenseEngine instance. This is the primary way to set up the engine with your license key, product bundle, an optional license store, and a license service builder.
```APIDOC
## init(licenseKey: String, productBundle: Bundle, licenseStore: LicenseStore?, licenseService: ServiceBuilder) async throws
### Description
Try to create a license engine with your license key. If your license key is valid, you will receive an engine instance.
### Parameters
#### Path Parameters
- **licenseKey** (String) - Required - Your LicenseKit license key.
- **productBundle** (Bundle) - Required - The bundle of your product.
- **licenseStore** (LicenseStore?) - Optional - An actor to store the active license.
- **licenseService** (ServiceBuilder) - Required - A typealias for a license service builder function.
```
--------------------------------
### Gold Tier Static Property
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensetier/gold
Access the static `gold` property to get the Gold tier instance. This is a read-only property.
```swift
static var gold: `Self` { get }
```
--------------------------------
### init(licenseYear:month:day:hour:minute:second:calendar:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/foundation/date/init%28licenseyear%3Amonth%3Aday%3Ahour%3Aminute%3Asecond%3Acalendar%3A%29
Creates a date with the specified license year, month, day, hour, minute, second, and calendar. Default values are provided for hour, minute, second, and calendar.
```APIDOC
## init(licenseYear:month:day:hour:minute:second:calendar:)
### Description
Create a date with a license time.
### Method
Initializer
### Parameters
#### Path Parameters
- **licenseYear** (Int) - Required - The year for the license date.
- **month** (Int) - Required - The month for the license date.
- **day** (Int) - Required - The day for the license date.
- **hour** (Int) - Optional - The hour for the license date. Defaults to 0.
- **minute** (Int) - Optional - The minute for the license date. Defaults to 0.
- **second** (Int) - Optional - The second for the license date. Defaults to 0.
- **calendar** (Calendar) - Optional - The calendar to use for the date. Defaults to `.current`.
### Code Example
```swift
init(
licenseYear year: Int,
month: Int,
day: Int,
hour: Int = 0,
minute: Int = 0,
second: Int = 0,
calendar: Calendar = .current
)
```
```
--------------------------------
### Get Current Platform
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseplatform
Determines and returns the `LicensePlatform` corresponding to the environment in which the code is currently running. This is useful for platform-specific logic.
```swift
static var current: LicensePlatform
```
--------------------------------
### SwiftUI OnAppear Modifier
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinfoview/view-implementations
Executes a closure when the view first appears on screen. Useful for data loading or initial setup.
```swift
func onAppear(perform: (() -> Void)?) -> some View
```
--------------------------------
### init(item:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforowview/init%28item%3A%29
Initializes a `LicenseInfoRowView` with a `LicenseInfoRow` object. This is the primary way to create an instance of this view, setting up its content based on the provided license data.
```APIDOC
## init(item:)
### Description
Initializes a `LicenseInfoRowView` with a `LicenseInfoRow` object. This is the primary way to create an instance of this view, setting up its content based on the provided license data.
### Method
Initializer
### Parameters
#### Path Parameters
- **item** (LicenseInfoRow) - Required - The license information to display in the row.
```
--------------------------------
### Set Line Limit (Partial Range From)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/view-implementations
Sets the line limit for text to a partial range starting from a specific number.
```swift
func lineLimit(PartialRangeFrom) -> some View
```
--------------------------------
### init(privateKey:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensefilegenerator/init%28privatekey%3A%29
Initializes the LicenseFileGenerator with a provided private key. This key is used for encrypting and generating license files.
```APIDOC
## init(privateKey:)
### Description
Creates a license file generator using a private encryption key.
### Method
`init` (initializer)
### Parameters
#### Parameters
- **privateKey** (String) - Required - Your private, unique encryption key. Use `generateUniqueEncryptionKey()` to generate an encryption key that is specific to your app/SDK.
```
--------------------------------
### typeSelectEquivalent(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/typeselectequivalent%28_%3A%29-1r6z7
This method is an instance method inherited from the View protocol. It is available on various Apple platforms starting from iOS 16.0.
```APIDOC
## typeSelectEquivalent(_:)
### Description
This instance method is inherited from the `View` protocol and is part of the `LicenseApp.LicenseFileDecryptionScreen`.
### Method Signature
```swift
nonisolated func typeSelectEquivalent(_ text: Text?) -> some View
```
### Availability
LicenseKitSwiftUICore
- iOS 16.0+
- iPadOS 16.0+
- Mac Catalyst 16.0+
- macOS 13.0+
- tvOS 16.0+
- watchOS 9.0+
```
--------------------------------
### all
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseenvironment/all
Retrieves all standard environments available in LicenseKit.
```APIDOC
## all
### Description
Get all standard environments.
### Method
static var
### Endpoint
LicenseEnvironment.all
### Response
#### Success Response
- `Self` (Array) - An array containing all standard environments.
```
--------------------------------
### textSelectionAffinity(_:) Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/textselectionaffinity%28_%3A%29
This is the method signature for textSelectionAffinity(_:). It is available on various Apple platforms starting from specific OS versions.
```swift
nonisolated
func textSelectionAffinity(_ affinity: TextSelectionAffinity) -> some View
```
--------------------------------
### init(url:httpMethod:httpHeaders:httpFormData:httpPostData:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseintegrations/apiconfiguration/init%28url%3Ahttpmethod%3Ahttpheaders%3Ahttpformdata%3Ahttppostdata%3A%29
Initializes an API configuration with the specified URL and optional HTTP parameters. This allows for custom configuration of network requests for license key retrieval.
```APIDOC
## init(url:httpMethod:httpHeaders:httpFormData:httpPostData:)
### Description
Creates an API configuration object used for license key retrieval.
### Parameters
`url` (UrlBuilder) - Required - The URL to use for a license key.
`httpMethod` (HttpMethodBuilder) - Optional - The HTTP method to use for a license key, defaults to "GET".
`httpHeaders` (HttpHeadersBuilder) - Optional - The HTTP headers to use for a license key, defaults to an empty dictionary `[:]`.
`httpFormData` (HttpFormDataBuilder) - Optional - The HTTP form data to use for a license key, defaults to `nil`.
`httpPostData` (HttpPostDataBuilder) - Optional - The HTTP post data to use for a license key, defaults to `nil`.
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/help%28_%3A%29-381bi
Adds a help button to the view that presents a popover with the specified help text. The help text is provided as a LocalizedStringKey.
```APIDOC
## help(_:)
### Description
Adds a help button to the view that presents a popover with the specified help text. The help text is provided as a LocalizedStringKey.
### Method
`func help(_ textKey: LocalizedStringKey) -> some View`
### Parameters
#### Path Parameters
- **textKey** (LocalizedStringKey) - Description of the help text to display.
```
--------------------------------
### Get all standard platforms
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/swift/collection/all-9gktb
Retrieves an array of all standard platforms available in LicenseKit. This is a static property of the `Element` type when `Element` is `LicensePlatform`.
```APIDOC
## all
### Description
Get all standard platforms.
### Type
`[Element]`
### Property
`static var all: [Element] { get }`
### Availability
Available when `Element` is `LicensePlatform`.
```
--------------------------------
### Get All License Environments in Swift
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/swift/collection/all-5j4ly
Use the static `all` property to retrieve an array of all available `LicenseEnvironment` elements. This is available when `Element` is `LicenseEnvironment`.
```swift
static var all: [Element] { get }
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/help%28_%3A%29-98zew
Displays help text associated with the LicenseInfoRow. This method is inherited from the View protocol and allows for the presentation of supplementary information.
```APIDOC
## Instance Method
# help(_:)
Inherited from `View.help(_:)`.
### Description
Displays help text associated with the LicenseInfoRow. This method is inherited from the View protocol and allows for the presentation of supplementary information.
### Signature
```swift
nonisolated func help(_ text: Text) -> some View
```
### Parameters
* **text** (`Text`) - The help text to display.
```
--------------------------------
### menuActionDismissBehavior(_:) Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/menuactiondismissbehavior%28_%3A%29
This snippet shows the signature of the `menuActionDismissBehavior(_:)` method. It is available on various Apple platforms starting from specific OS versions.
```swift
nonisolated
func menuActionDismissBehavior(_ behavior: MenuActionDismissBehavior) -> some View
```
--------------------------------
### init(_:_:_:) Initializer
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/init%28_%3A_%3A_%3A%29-1k2ic
Initializes a LicenseInfoRow with a title, a dictionary of values, and an optional color.
```APIDOC
## init(_:_:_:)
### Description
Initializes a new instance of `LicenseApp.LicenseInfoRow` with a localized title, a dictionary of string key-value pairs, and an optional color.
### Parameters
#### Path Parameters
* None
#### Query Parameters
* None
#### Request Body
* **title** (LocalizedStringKey) - Required - The localized title for the row.
* **values** ([String : String]?) - Optional - A dictionary of string key-value pairs to display.
* **color** (Color?) - Optional - The color for the row, defaults to nil.
### Request Example
```swift
LicenseApp.LicenseInfoRow("License Title", ["Key1": "Value1", "Key2": "Value2"], Color.blue)
```
### Response
#### Success Response (200)
* N/A (Initializers do not have responses in the traditional sense.)
#### Response Example
* N/A
```
--------------------------------
### LicenseKitSwiftUICore accessibilityAddTraits(_:) Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/accessibilityaddtraits%28_%3A%29
This is the signature for the accessibilityAddTraits(_:) method. It is inherited from View and is available on multiple Apple platforms starting from iOS 14.0.
```swift
nonisolated
func accessibilityAddTraits(_ traits: AccessibilityTraits) -> ModifiedContent
```
--------------------------------
### init(licenseKey:name:source:customer:tier:activationDate:billingDate:renewalDate:expirationDate:expirationProductVersion:allowsExpiration:renewalPrice:bundleIds:platforms:environments:features:featureIds:additionalInfo:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license/init%28licensekey%3Aname%3Asource%3Acustomer%3Atier%3Aactivationdate%3Abillingdate%3Arenewaldate%3Aexpirationdate%3Aexpirationproductversion%3Aallowsexpiration%3Arenewalprice%3Abundleids%3Aplatforms%3Aenvironments%3Afeatures%3Afeatureids%3Aadditionalinfo%3A%29
Creates a new license object with the specified details. This initializer allows for comprehensive configuration of license properties, including key, customer information, dates, pricing, and feature/platform restrictions.
```APIDOC
## init(licenseKey:name:source:customer:tier:activationDate:billingDate:renewalDate:expirationDate:expirationProductVersion:allowsExpiration:renewalPrice:bundleIds:platforms:environments:features:featureIds:additionalInfo:)
### Description
Create a new license.
### Method
Initializer
### Parameters
#### Path Parameters
- **licenseKey** (String) - Required - The unique license key.
- **name** (String?) - Optional - The name of the licensed product, if any.
- **source** (LicenseSource?) - Optional - The source of the license, if any.
- **customer** (LicenseCustomer?) - Optional - The license customer, if any, if any.
- **tier** (LicenseTier) - Optional - The license tier, by default `.standard`.
- **activationDate** (Date?) - Optional - The date when the license was first activated, if any.
- **billingDate** (Date?) - Optional - The date when the next invoide should be issued, if any.
- **renewalDate** (Date?) - Optional - The date when the license should be renewed, if any.
- **expirationDate** (Date?) - Optional - The date when the license expires, if any.
- **expirationProductVersion** (Double?) - Optional - The product version whe the license expires, if any.
- **allowsExpiration** (Bool) - Optional - Defaults to `false`.
- **renewalPrice** (Double?) - Optional - The license renewal price, if any.
- **bundleIds** (Array) - Optional - The bundle IDs for which the license is valid, by default `[]`.
- **platforms** (Array) - Optional - The platforms for which the license is valid, by default `Platform/all`.
- **environments** (Array) - Optional - The environments for which the license is valid, by default `Environment/all`.
- **features** (Array) - Optional - The features license gives access to, by default `[]`.
- **featureIds** (Array) - Optional - The feature IDs the license gives access to, by default `[]`.
- **additionalInfo** (Dictionary) - Optional - Additional customer information, if any.
```
--------------------------------
### Create a License Engine with Compiled Licenses
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/getting-started-article
Instantiate a LicenseEngine with your license key and add LicenseServiceTypes for on-device validation.
```swift
let engine = try LicenseEngine(licenseKey: "YOUR_LICENSE_KEY",
licenseServiceTypes: [CompiledLicenseServiceType(),
CompiledLicenseServiceType()])
```
--------------------------------
### LicenseTier.startup
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensetier/startup
Provides access to the predefined startup license tier. This is a static property that returns an instance of `Self` (LicenseTier).
```APIDOC
## LicenseTier.startup
### Description
Provides access to the predefined startup license tier. This is a static property that returns an instance of `Self` (LicenseTier), representing a tier with a level of 1.
### Method
static var startup: `Self` { get }
### Parameters
None
### Response
#### Success Response
- **startup** (`Self`) - An instance of LicenseTier representing the startup tier.
```
--------------------------------
### Get all available known license sources
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/swift/collection/all-6syx7
Retrieves an array of all available license sources known to LicenseKit. This is a static property that can be accessed directly.
```APIDOC
## all
### Description
Get all available known license sources.
### Type
`LicenseKitSwift.Element` (when `Element` is `LicenseSource`)
### Property
`static var all: [Element] { get }`
### Usage
This property is available when `Element` is specifically a `LicenseSource`. It provides a read-only collection of all recognized license sources.
```
--------------------------------
### help(_:) Instance Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/help%28_%3A%29-6mc6q
This is the signature for the `help(_:)` instance method. It takes a `Text` object as input and returns a `View`.
```swift
nonisolated
func help(_ text: Text) -> some View
```
--------------------------------
### Set Matched Transition Source (Configurable)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/view-implementations
Designates a view as a source for matched transitions with a configurable closure. Use for advanced transition setups.
```swift
func matchedTransitionSource(id: some Hashable, in: Namespace.ID, configuration: (EmptyMatchedTransitionSourceConfiguration) -> some MatchedTransitionSourceConfiguration) -> some View
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseservicescreen/help%28_%3A%29-87gmc
This instance method, inherited from `View`, allows displaying help text associated with a view. It takes a `LocalizedStringResource` as input and returns a modified `View`.
```APIDOC
## help(_:)
### Description
Displays help text associated with a view. This method is inherited from the `View` protocol.
### Method Signature
`func help(_ textKey: LocalizedStringResource) -> some View`
### Parameters
#### Path Parameters
- **textKey** (LocalizedStringResource) - Required - The localized string resource to display as help text.
### Response
Returns `some View`, which is a modified view with the help text integrated.
```
--------------------------------
### accessibilityRemoveTraits(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensemanagerapp/accessibilityremovetraits%28_%3A%29
Removes specified accessibility traits from a view. This method is inherited from `View.accessibilityRemoveTraits(_:)` and is available on various Apple platforms starting from iOS 14.0.
```APIDOC
## accessibilityRemoveTraits(_:)
### Description
Removes specified accessibility traits from a view. This method is inherited from `View.accessibilityRemoveTraits(_:)` and is available on various Apple platforms starting from iOS 14.0.
### Method Signature
`func accessibilityRemoveTraits(_ traits: AccessibilityTraits) -> ModifiedContent`
### Parameters
#### Path Parameters
- **traits** (AccessibilityTraits) - Required - The accessibility traits to remove from the view.
```
--------------------------------
### help(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforowview/help%28_%3A%29-3p9ys
This method is inherited from the `View` protocol and allows adding help text to a view. It accepts any `StringProtocol` as input for the help text.
```APIDOC
## help(_:)
### Description
Adds help text to a view. This method is inherited from the `View` protocol.
### Method Signature
```swift
nonisolated func help(_ text: S) -> some View where S : StringProtocol
```
### Parameters
* **text** (S : StringProtocol) - The help text to display. It can be any type conforming to `StringProtocol`.
```
--------------------------------
### keyframeAnimator
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensekeygeneratorscreen/keyframeanimator%28initialvalue%3Atrigger%3Acontent%3Akeyframes%3A%29
Animates a view's properties using a sequence of keyframes. The animation is triggered by changes in the `trigger` parameter and uses the `initialValue` to start.
```APIDOC
## keyframeAnimator(initialValue:trigger:content:keyframes:)
### Description
Animates a view's properties over a sequence of keyframes. The animation is triggered by changes in the `trigger` parameter and uses the `initialValue` to start. The `content` closure defines the view's appearance at different stages of the animation, and the `keyframes` closure defines the animation's progression.
### Method Signature
```swift
nonisolated func keyframeAnimator(
initialValue: Value,
trigger: some Equatable,
@ViewBuilder content: @escaping (PlaceholderContentView, Value) -> some View,
@KeyframesBuilder keyframes: @escaping (Value) -> some Keyframes
) -> some View
```
### Parameters
#### Path Parameters
- **initialValue** (Value) - The starting value for the animation.
- **trigger** (some Equatable) - A value that, when changed, triggers the animation.
- **content** (@ViewBuilder (PlaceholderContentView, Value) -> some View) - A closure that returns the view content, taking the placeholder view and the current animation value.
- **keyframes** (@KeyframesBuilder (Value) -> some Keyframes) - A closure that defines the animation's keyframes based on the animation value.
```
--------------------------------
### transition(_:) Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/transition%28_%3A%29
This is the signature for the `transition(_:)` instance method, inherited from `View`. It is available on various Apple platforms starting from iOS 13.0.
```swift
nonisolated
func transition(_ t: AnyTransition) -> some View
```
--------------------------------
### LicenseApp.LicenseInfoRow.init(_:_:_:) Initializer
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/init%28_%3A_%3A_%3A%29-3tp4o
Initializes a new instance of LicenseApp.LicenseInfoRow with a title, an optional array of values, and an optional color.
```APIDOC
## init(_:_:_:) Initializer
### Description
Initializes a new instance of `LicenseApp.LicenseInfoRow` with a title, an optional array of values, and an optional color.
### Parameters
#### Initializer Parameters
- **title** (LocalizedStringKey) - The title for the row.
- **values** ([String]?) - An optional array of strings to display as values.
- **color** (Color?) - An optional color for the row. Defaults to nil.
```
--------------------------------
### textEditorStyle(_:) Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/texteditorstyle%28_%3A%29
This snippet shows the signature of the `textEditorStyle(_:)` method. It is available on various Apple platforms starting from specific OS versions.
```swift
nonisolated
func textEditorStyle(_ style: some TextEditorStyle) -> some View
```
--------------------------------
### help(_:) Instance Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/help%28_%3A%29-6rlgi
This is the signature for the `help(_:)` instance method. It accepts a StringProtocol and returns a View. Ensure your project supports iOS 14.0+ or equivalent.
```swift
nonisolated
func help(_ text: S) -> some View where S : StringProtocol
```
--------------------------------
### License Initializer
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license
Creates a new license instance with detailed configuration. Use this to programmatically generate license objects.
```swift
init(licenseKey: String, name: String?, source: LicenseSource?, customer: LicenseCustomer?, tier: LicenseTier, activationDate: Date?, billingDate: Date?, renewalDate: Date?, expirationDate: Date?, expirationProductVersion: Double?, allowsExpiration: Bool, renewalPrice: Double?, bundleIds: [String], platforms: [LicensePlatform], environments: [LicenseEnvironment], features: [any LicenseFeature], featureIds: [String], additionalInfo: [String : String])
```
--------------------------------
### scrollInputBehavior(_:for:) Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/scrollinputbehavior%28_%3Afor%3A%29
This is the instance method signature for scrollInputBehavior(_:for:). It is inherited from View and is available on various Apple platforms starting from version 18.0.
```swift
@MainActor @preconcurrency
func scrollInputBehavior(
_ behavior: ScrollInputBehavior,
for input: ScrollInputKind
) -> some View
```
--------------------------------
### LicenseServiceType.binary(licenses:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseservicetype/binary%28licenses%3A%29
Creates a binary license service with a hard-coded list of customer licenses. This is useful for bundling licenses directly with your product binary.
```APIDOC
## LicenseServiceType.binary(licenses:)
A binary license service.
### Method Signature
```swift
case binary(licenses: [License])
```
### Parameters
#### `licenses`
- **licenses** ([License]) - Required - A hard-coded list of customer licenses.
### Description
This service can be created with hard-coded licenses values, that can be bundled with your product binary.
```
--------------------------------
### allowsTightening(_:) Method Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/allowstightening%28_%3A%29
This snippet shows the nonisolated function signature for allowsTightening(_:). It is available on multiple Apple platforms starting from iOS 13.0.
```swift
nonisolated
func allowsTightening(_ flag: Bool) -> some View
```
--------------------------------
### alignmentGuide(_:computeValue:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/alignmentguide%28_%3Acomputevalue%3A%29-7qr7a
Configures a custom alignment guide for a view. This method allows you to define how a view aligns itself within its parent based on a computed value.
```APIDOC
## alignmentGuide(_:computeValue:)
### Description
Configures a custom alignment guide for a view. This method allows you to define how a view aligns itself within its parent based on a computed value.
### Method
Instance Method
### Signature
@preconcurrency nonisolated func alignmentGuide(
_ g: HorizontalAlignment,
computeValue: @escaping (ViewDimensions) -> CGFloat
) -> some View
### Parameters
#### Path Parameters
* `g` (HorizontalAlignment) - The horizontal alignment guide to use.
* `computeValue` (@escaping (ViewDimensions) -> CGFloat) - A closure that computes the alignment value for the view based on its dimensions.
### Inheritance
Inherited from `View.alignmentGuide(_:computeValue:)`.
### Availability
LicenseKitSwiftUICore
iOS 13.0+
iPadOS 13.0+
Mac Catalyst 13.0+
macOS 10.15+
tvOS 13.0+
watchOS 6.0+
```
--------------------------------
### init(_:_:_:) Initializer
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforow/init%28_%3A_%3A_%3A%29-13bm0
Initializes a new instance of LicenseInfoRow with a title, a date value, and an optional color.
```APIDOC
## init(_:_:_:) Initializer
### Description
Initializes a new instance of `LicenseInfoRow` with a title, a date value, and an optional color.
### Parameters
- **title** (LocalizedStringKey) - Required - The title for the row.
- **value** (Date?) - Required - The date value to display. Can be nil.
- **color** (Color?) - Optional - The color for the row. Defaults to nil.
```
--------------------------------
### Basic License Tier Property
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensetier/basic
Access the static property `basic` to get an instance of the basic license tier. This tier is defined with a level of 0.
```swift
static var basic: `Self` { get }
```
--------------------------------
### Setup API License Service
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/understanding-services
Configure and set up an API license service for LicenseKit. This involves defining the API endpoint, HTTP method, headers, and a mapping function to decode API responses into License objects.
```swift
let engine = try await LicenseEngine(
licenseKey: "your-licensekit-license-key"
) { engineLicense in
try .api(
configuration: .init(
url: { licenseKey in URL(string: "https://myapi.com/licenses/\(licenseKey)")! },
httpMethod: { _ in "POST" },
httpHeaders: { _ in ["api-token": "ejiwaogja="] }
),
licenseMapping { data in
let decoder = JSONDecoder()
let apiLicense = try decoder.decode(MyApiLicenseModel.self, from: data)
return apiLicense.license
}
)
}
```
--------------------------------
### Setup Proxy Service for Multiple License Sources
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/understanding-services
Configures the LicenseEngine to use a proxy service that combines multiple license validation sources. This allows for sequential validation across different service types like binary and Gumroad.
```swift
let engine = try await LicenseEngine(
licenseKey: "your-licensekit-license-key"
) { engineLicense in
.proxy(
services: [
.binary(...),
.gumroad(...)
]
)
}
```
--------------------------------
### Accessing localizedDescription
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/license/encryptedfileerror/localizeddescription
You can access the `localizedDescription` property on an instance of `License.EncryptedFileError` to get a user-facing string explaining the error. This is useful for displaying error messages to the user.
```swift
var localizedDescription: String { get }
```
--------------------------------
### init(name:level:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensetier/init%28name%3Alevel%3A%29
Creates a custom license tier with a specified name and service level.
```APIDOC
## init(name:level:)
### Description
Creates a custom license tier.
### Method
Initializer
### Parameters
#### Parameters
- **name** (String) - Required - The name of the tier.
- **level** (Int) - Required - The level of service that the tier provides.
```
--------------------------------
### init(license:fileGenerator:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinfoview/init%28license%3Afilegenerator%3A%29
Initializes a new instance of LicenseInfoView. This initializer takes a required `License` object and an optional `LicenseFileGenerator`.
```APIDOC
## init(license:fileGenerator:)
### Description
Initializes a new instance of `LicenseInfoView` with the specified license and an optional file generator.
### Parameters
#### Initializer Parameters
- **license** (License) - Required - The license object to be used.
- **fileGenerator** (LicenseFileGenerator?) - Optional - An optional file generator to be used for license file operations.
```
--------------------------------
### alignmentGuide(_:computeValue:) Signature
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licensefiledecryptionscreen/alignmentguide%28_%3Acomputevalue%3A%29-7qr7a
This is the signature for the alignmentGuide instance method, which allows for custom alignment logic based on computed values.
```swift
@preconcurrency nonisolated
func alignmentGuide(
_ g: HorizontalAlignment,
computeValue: @escaping (ViewDimensions) -> CGFloat
) -> some View
```
--------------------------------
### presentationBackgroundInteraction(_:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licensemanagerapp/presentationbackgroundinteraction%28_%3A%29
Controls the background interaction behavior for a view. This method is inherited from the View protocol and is available on various Apple platforms starting from iOS 16.4.
```APIDOC
## presentationBackgroundInteraction(_:)
### Description
Controls the background interaction behavior for a view. This method is inherited from the View protocol and is available on various Apple platforms starting from iOS 16.4.
### Method Signature
```swift
nonisolated func presentationBackgroundInteraction(_ interaction: PresentationBackgroundInteraction) -> some View
```
### Parameters
#### Path Parameters
- **interaction** (PresentationBackgroundInteraction) - Description of the interaction behavior to apply.
### Platforms
LicenseKitSwiftUICore
iOS 16.4+
iPadOS 16.4+
Mac Catalyst 16.4+
macOS 13.3+
tvOS 16.4+
watchOS 9.4+
```
--------------------------------
### luminanceToAlpha()
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseservicescreen/luminancetoalpha%28%29
The luminanceToAlpha() instance method is inherited from the View protocol. It is used within the LicenseApp.LicenseServiceScreen and is available on multiple Apple platforms starting from iOS 13.0.
```APIDOC
## luminanceToAlpha()
### Description
Inherited from `View.luminanceToAlpha()`.
This method is part of LicenseKitSwiftUICore and is available on iOS, iPadOS, Mac Catalyst, macOS, tvOS, and watchOS.
### Method Signature
```swift
nonisolated
func luminanceToAlpha() -> some View
```
### Parameters
This method does not accept any parameters.
### Returns
Returns `some View`, indicating a view that conforms to the View protocol. The specific type is opaque.
### Availability
- iOS 13.0+
- iPadOS 13.0+
- Mac Catalyst 13.0+
- macOS 10.15+
- tvOS 13.0+
- watchOS 6.0+
```
--------------------------------
### standard(for:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseintegrations/apiconfiguration/standard%28for%3A%29
Creates a standard API configuration using a URL builder. This is a static method available on the `LicenseIntegrations.ApiConfiguration` type.
```APIDOC
## standard(for:)
### Description
A standard API configuration.
### Method
`static func`
### Signature
`standard(for url: @escaping UrlBuilder) -> LicenseIntegrations.ApiConfiguration`
### Parameters
#### Path Parameters
- **url** (`@escaping UrlBuilder`) - Required - A URL builder function to define the API endpoint.
```
--------------------------------
### confirmationDialog(_:isPresented:titleVisibility:actions:)
Source: https://kankoda.github.io/LicenseKit/documentation/licensekit/licenseapp/licenseinforowview/confirmationdialog%28_%3Aispresented%3Atitlevisibility%3Aactions%3A%29-2llrq
Presents a confirmation dialog. This method is inherited from `View` and is available in various Apple platforms starting from iOS 16.0.
```APIDOC
## confirmationDialog(_:isPresented:titleVisibility:actions:)
### Description
Displays a confirmation dialog with a title, a binding to control its presentation, an optional title visibility, and a closure for actions.
### Method Signature
```swift
func confirmationDialog(
_ titleResource: LocalizedStringResource,
isPresented: Binding,
titleVisibility: Visibility = .automatic,
@ViewBuilder actions: () -> A
) -> some View where A : View
```
### Parameters
- **titleResource** (LocalizedStringResource) - The title of the confirmation dialog.
- **isPresented** (Binding) - A binding to a Boolean value that determines whether the confirmation dialog is presented.
- **titleVisibility** (Visibility) - An optional value that specifies the visibility of the dialog's title. Defaults to `.automatic`.
- **actions** (@ViewBuilder () -> A) - A closure that returns the actions to be displayed in the confirmation dialog. The type `A` must conform to `View`.
```