CLUReportFileManager

@interface CLUReportFileManager : NSObject

CLUReportFileManager is a singleton class responsible for managing final report .clue file and interact which it on file system level

.clue file is a package consists of two subdirectories Info and Modules Info directory contains all static modules like: info_device.json (with statis device information) Modules directory contains all real-time, recordable modules like: module_interaction.json (with all user touches), module_network.json (with all network communications), module_view.json (with all view mutation), module_video.mp4 (with screen cast).

  • URL of recordable modules directory Modules inside .clue package file

    Warning

    Client can’t change this value, it configures during first CLUReportFileManager initialization

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSURL *recordableModulesDirectoryURL;

    Swift

    var recordableModulesDirectoryURL: URL! { get }

  • URL of static modules directory Info inside .clue package file

    Warning

    Client can’t change this value, it configures during first CLUReportFileManager initialization

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSURL *infoModulesDirectoryURL;

    Swift

    var infoModulesDirectoryURL: URL! { get }

  • URL of final .clue file which located in tmp directory of current application

    Warning

    Client can’t change this value, it configures during first CLUReportFileManager initialization

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSURL *reportDirectoryURL;

    Swift

    var reportDirectoryURL: URL! { get }

  • URL of .clue zip file which located in tmp directory of current application. Used for email attachment after successful recording

    Warning

    Client can’t change this value, it configures during first CLUReportFileManager initialization

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSURL *reportZipURL;

    Swift

    var reportZipURL: URL! { get }

  • Returns the shared singleton instance of CLUReportFileManager

    Declaration

    Objective-C

    + (instancetype)sharedManager;

    Swift

    class func shared() -> Self!

    Return Value

    Shared singleton instance of CLUReportFileManager

  • Create new report file with UUID as a name and with configured structure (with created Modules and Info subdirectories)

    Declaration

    Objective-C

    - (BOOL)createReportFile;

    Swift

    func createReportFile() -> Bool

    Return Value

    BOOL values that indicated whether report file creation was successful or not

  • Remove report file with all subdirectories inside

    Declaration

    Objective-C

    - (BOOL)removeReportFile;

    Swift

    func removeReportFile() -> Bool

    Return Value

    BOOL values that indicated whether report file removal was successful or not

  • Remove zip file with report inside

    Declaration

    Objective-C

    - (BOOL)removeReportZipFile;

    Swift

    func removeReportZipFile() -> Bool

    Return Value

    BOOL values that indicated whether report file removal was successful or not

  • Create zip archive file with .clue report file inside

    Declaration

    Objective-C

    - (BOOL)createZipReportFile;

    Swift

    func createZipReportFile() -> Bool

    Return Value

    BOOL values that indicated whether report file removal was successful or not

  • Check if report zip file is available at CLUReportFileManager.reportZipURL

    Declaration

    Objective-C

    - (BOOL)isReportZipFileAvailable;

    Swift

    func isReportZipFileAvailable() -> Bool

    Return Value

    BOOL values that indicated whether report file exists at CLUReportFileManager.reportZipURL or not