# BundleManager

    @objc(LSBundleManager)
    final class BundleManager : BaseManager

    extension BundleManager : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol

Entry point to the LicenseSpring SDK Class for performing basic requests to LicenseSpring backend and managing license bundles

- `init(configuration:)`

  Initializes the BundleManager with the given configuration

  Throws

  `LSError` if configuration is invalid

  #### Declaration

  Swift

      override init(configuration: Configuration) throws

  #### Parameters

  `configuration` | LicenseSpring configuration object

- `cachedLicenses`

  Activated Bundle or empty dictionary if no license is active.

  #### Declaration

  Swift

      @objc
      var cachedLicenses: LicenseBundle

- `activateBundle(licenseKey:)`

  Activate the bundle using license key.

  Throws

  Error if license activation fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func activateBundle(licenseKey: String) throws -> LicenseBundle

  #### Parameters

  `licenseKey` | License key for the product.

  #### Return Value

  Activated bundle.

- `activateBundle(username:password:)`

  Activate the license bundle using username and password.

  Throws

  Error if license activation fails. May be of `LSError` type. @objc

  #### Declaration

  Swift

      func activateBundle(username: String, password: String) throws -> LicenseBundle

  #### Parameters

  `password` | User’s password.

  #### Return Value

  Activated bundle.

- `activateBundle(username:password:serverId:)`

  Activate the license bundle using username and password.

  Throws

  Error if license activation fails. May be of `LSError` type. @objc

  #### Declaration

  Swift

      @objc
      func activateBundle(username: String, password: String, serverId: Int64) throws -> LicenseBundle

  #### Parameters

  `password` | User’s password.

  #### Return Value

  Activated bundle.

- `activateBundle(idToken:)`

  Activate the bundle using idToken

  Throws

  Error if license activation fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func activateBundle(idToken: String) throws -> LicenseBundle

  #### Return Value

  Activated bundle.

- `activateBundle(code:)`

  Activate the bundle using code

  Throws

  Error if license activation fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func activateBundle(code: String) throws -> LicenseBundle

  #### Return Value

  Activated bundle.

- `deactivateBundle(licenseKey:removeLocalData:)`

  Deactivates the license bundle using licenseKey.

  #### Declaration

  Swift

      @objc
      func deactivateBundle(licenseKey: String, removeLocalData: Bool = true) -> Bool

  #### Parameters

  `licenseKey` | License key for the product
  `removeLocalData` | flag to remove local bundle data

  #### Return Value

  True if the deactivation is successfull

- `deactivateBundle(username:password:removeLocalData:)`

  Deactivates the license bundle using username and password.

  #### Declaration

  Swift

      @objc
      func deactivateBundle(username: String, password: String, removeLocalData: Bool = true) -> Bool

  #### Parameters

  `password` | User’s password.
  `removeLocalData` | flag to remove local bundle data

  #### Return Value

  True if the deactivation is successfull

- `deactivateBundle(idToken:customerAccountCode:removeLocalData:)`

  Deactivates the license bundle using idToken and customerAccountCode.

  #### Declaration

  Swift

      @objc
      func deactivateBundle(idToken: String, customerAccountCode: String, removeLocalData: Bool = true) -> Bool

  #### Parameters

  `idToken` |
  `customerAccountCode` | .
  `removeLocalData` | flag to remove local bundle data

  #### Return Value

  True if the deactivation is successfull

- `deactivateBundle(code:customerAccountCode:removeLocalData:)`

  Deactivates the license bundle using code and customerAccountCode.

  #### Declaration

  Swift

      @objc
      func deactivateBundle(code: String, customerAccountCode: String, removeLocalData: Bool = true) -> Bool

  #### Parameters

  `code` |
  `customerAccountCode` | .
  `removeLocalData` | flag to remove local bundle data

  #### Return Value

  True if the deactivation is successfull

- `checkBundle(licenseKey:)`

  Check bundle for validity on the LicenseSpring platform.

  Throws

  Error if remote or local checks fail.

  #### Declaration

  Swift

      @objc
      func checkBundle(licenseKey: String) throws -> LicenseBundle

  #### Parameters

  `licenseKey` | License key for the product.

  #### Return Value

  Current bundle.

- `checkBundle(username:)`

  Check bundle for validity on the LicenseSpring platform.

  Throws

  Error if remote or local checks fail.

  #### Declaration

  Swift

      @objc
      func checkBundle(username: String) throws -> LicenseBundle

  #### Parameters

  `username` | User ID, typically email in lowercase.

  #### Return Value

  Current bundle.

- `requestSSOURL()`

  Retrieve URL for Single Sign-On license activation.

  Throws

  Error if request fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func requestSSOURL() throws -> URL

  #### Return Value

  URL for Single Sign-On.

- `activateBundleOffline(_:)`

  Activate the license using license activation response file.

  Throws

  Error if license activation fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func activateBundleOffline(_ activationResponseFile: URL) throws -> LicenseBundle

  #### Parameters

  `activationResponseFile` | Activation response file location.

  #### Return Value

  Activated license bundle.

- `createOfflineActivationFile(licenseKey:preferredLocation:)`

  Creates offline activation file request.

  Throws

  Error if create activation file fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func createOfflineActivationFile(licenseKey: String, preferredLocation: URL? = nil) throws -> URL

  #### Parameters

  `licenseKey` | License key to be activated offline.
  `preferredLocation` | Optional custom activation request file location. ‘~/Desktop/ls_activation.req’ by default.

  #### Return Value

  Location of offline activation file request.

- `createOfflineActivationFile(user:password:preferredLocation:serverID:)`

  Creates offline activation file request.

  Throws

  Error if create activation file fails. May be of `LSError` type.

  #### Declaration

  Swift

      @objc
      func createOfflineActivationFile(user: String, password: String, preferredLocation: URL? = nil, serverID: Int64 = 0) throws -> URL

  #### Parameters

  `user` | User ID, typically email in lowercase.
  `password` | User’s password.
  `preferredLocation` | Optional custom activation request file location. ‘~/Desktop/ls_activation.req’ by default.
  `serverID` | serverID, server-side license identifier, typically 64-bit id.

  #### Return Value

  Location of offline activation file request.

- `deactivateBundleOffline(licenseKey:serverID:preferredLocation:)`

  Creates the deactivate bundle offline request

  #### Declaration

  Swift

      @objc
      func deactivateBundleOffline(licenseKey: String, serverID: Int64 = 0, preferredLocation: URL? = nil) throws -> URL

  #### Parameters

  `licenseKey` | licenseKey: License key to be activated offline.

- `deactivateBundleOffline(username:serverID:preferredLocation:)`

  Creates the deactivate bundle offline request

  #### Declaration

  Swift

      @objc
      func deactivateBundleOffline(username: String, serverID: Int64 = 0, preferredLocation: URL? = nil) throws -> URL

  #### Parameters

  `username` | User ID, typically email in lowercase.

- `getCurrentBundle()`

  Returns current bundle of licenses (from memory or disk)

  #### Declaration

  Swift

      func getCurrentBundle() throws -> LicenseBundle

  #### Return Value

  current License Bundle

- `loadLicensesFromStorage()`

  Loads all licenses in a bundle from persistent storage

  #### Declaration

  Swift

      func loadLicensesFromStorage() throws -> LicenseBundle

  #### Return Value

  current License Bundle

- `getCurrentLicense()`

  Undocumented

  #### Declaration

  Swift

      func getCurrentLicense() -> License?

© 2025 LicenseSpring. All rights reserved. (Last updated: 2025-10-22)

Generated by jazzy ♪♫ v0.15.3, a Realm project.