Configuration

@objc(LSConfiguration)
final class Configuration
extension Configuration : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol

LicenseSpring SDK configuration.

  • API key acquired from LicenseSpring.

    Declaration

    Swift

    @objc
    let apiKey: String
  • Shared key acquired from LicenseSpring.

    Declaration

    Swift

    @objc
    let sharedKey: String
  • Product code code acquired from LicenseSpring.

    Declaration

    Swift

    @objc
    let productCode: String
  • Application name. Defaults to main application bundle name if not set.

    Declaration

    Swift

    @objc
    var appName: String
  • Application version. Defaults to main application bundle short version if not set.

    Declaration

    Swift

    @objc
    var appVersion: String
  • Customer group (account) code that is required for SSO.

    Note

    Meaningful for user-based auth only. If you don’t plan to provide SSO you can ignore this method. By default empty. Contact support to get more details implementing SSO.

    Declaration

    Swift

    @objc
    var customerAccountCode: String?
  • Air gap public key.

    Declaration

    Swift

    @objc
    var airgapKey: String?
  • Custom name of local license file.

    Declaration

    Swift

    @objc
    var licenseFileName: String
  • Custom directory containing local license file.

    Declaration

    Swift

    @objc
    var licenseDirectoryPath: URL
  • Alternate base URL for LicenseSpring API.

    Note

    In general should not be used in client code.

    Declaration

    Swift

    @objc
    var serviceURL: URL
  • Custom hardware ID of the device.

    Declaration

    Swift

    @objc
    var hardwareID: String
  • Boolean indicates if SDK should send host, local IP and MAC to the LicenseSpring platform.

    Declaration

    Swift

    @objc
    var collectHostNameAndLocalIP: Bool
  • Timeout value for network operations.

    Declaration

    Swift

    @objc
    var networkTimeout: TimeInterval
  • Timeout value for network operations.

    Declaration

    Swift

    @objc
    var licenseCryptor: LicenseCryptor
  • HTTPs proxy host.

    Declaration

    Swift

    @objc
    var proxyHost: String?
  • HTTPs proxy port.

    Declaration

    Swift

    @objc
    var proxyPort: UInt16
  • License grace period in seconds.

    If not set, then default will be 48 hours. Set 0 to disable grace period.

    For cloud floating licenses grace period on license check is enabled if more than an hour of floating period remains.

    Declaration

    Swift

    @objc
    var gracePeriod: TimeInterval
  • Undocumented

    Declaration

    Swift

    @objc
    init(apiKey: String, sharedKey: String, productCode: String)
  • Undocumented

    Declaration

    Swift

    static let defaultServiceURL: URL
  • Undocumented

    Declaration

    Swift

    static let defaultLicenseFileName: String
  • Full path to the license file.

    Declaration

    Swift

    @objc
    var licenseFile: URL { get }