ClarityJSONDirectoryState

enum ClarityJSONDirectoryState : Equatable

An enum for storing the state of the missing item status of the ClarityJSON directory.

  • A ClarityJSON directory has been copied to the client application and contains all the required JSON files.

    Declaration

    Swift

    case allFilesPresent

  • A ClarityJSON directory has not been copied to the client application or has been copied but does not contain any required JSON file.

    Declaration

    Swift

    case noDirectoryOrEmptyDirectory

  • A ClarityJSON directory has been copied to the client application but does not contain any valid EntityLogService JSON file.

    Declaration

    Swift

    case noEntityLogs

  • A ClarityJSON directory has been copied to the client application but does not contain either of the user preference files.

    Declaration

    Swift

    case missingPreferenceFiles

  • A ClarityJSON directory has been copied to the client application but does not contain one of the user preference files.

    • missingFileType: the name of the missing preference file.

    Declaration

    Swift

    case missingPreferenceFile(missingFileType: String)

  • A ClarityJSON directory has been copied to the client application but does not contain any valid EntityLogService JSON file and is missing one of the user preference files.

    • missingFileType: the name of the missing preference file.

    Declaration

    Swift

    case noEntityLogsMissingPreferenceFile(missingFileType: String)

  • A computed variable that returns a string representation of the value of enum cases regarding missing preference files.

    This variable is required to allow a common evaluation of all three cases that would otherwise not be possible because two cases have associated types and one case does not.

    Declaration

    Swift

    var missingFileType: String { get }

  • A computed variable that returns a string representation of the name of enum cases regarding missing preference files.

    This variable is required to allow a common description of all three cases that would otherwise not be possible because two cases have associated types and one case does not.

    Declaration

    Swift

    var description: String { get }