ConfigurationProviding

public protocol ConfigurationProviding

Definition that configuration providers must adhere to.

  • A read-only property that defines a class-level identifier for a given configuration provider.

    Declaration

    Swift

    var providerIdentifier: String { get }
  • Reports what input(s), if any, are required for operation. An empty Dictionary indicates no input is required.

    Declaration

    Swift

    var expectedInput: [String : Any] { get }
  • Attempts to obtain data if required input has been supplied.

    Declaration

    Swift

    func provideConfiguration(input: [String : Any]) -> (providerSuccess: Bool, configuration: NSDictionary, returnError: Error?)

    Parameters

    input

    Data supplied by app in response to expectedInput dictionary.

    Return Value

    A tuple consisting of providerSuccess (success/fail result), configuration if available, and returnError if applicable.