Bug Reporting Callbacks

Covered here are event handlers that you can use to have a block of code executed when a certain action is triggered for your iOS apps.

Before Invoking Luciq

This block is executed on the UI thread. You can use it to perform any UI changes before the SDK's UI is shown.

Swift

BugReporting.willInvokeHandler = {
    someObject.setSomeState()
}

Objective-C

Before Sending a Report

This block is executed in the background before sending each report. You can use it to attach logs and extra data to reports. You can also use this API to run some logic after the bug is reported and before it gets synced with the backend in case you need to access some data to take specific actions.

Data Available: tags, luciqLogs, consoleLogs, userAttributes, fileLocations, userData

Swift

Luciq.willSendReportHandler = { report in
    report.appendTag("tag1")
    report.logVerbose("Verbose log.")
    report.append(toConsoleLogs: "Console log statement.")
    report.setUserAttribute("value", withKey: "key")
    let data = "Data".data(using: .utf8)
    report.addFileAttachment(with: data)
    
    return report
}

Objective-C

By writing report. in the Event Handler, the IDE autocomplete feature will show all of the mentioned operations that you can do or access on the report automatically.

After Dismissing Luciq

This block is executed on the UI thread. You can use it to perform any UI changes after the SDK's UI has been dismissed.

Swift

BugReporting.didDismissHandler = { (SDKDismissType, ReportCategory) in
    someObject.setSomeState()
}

Objective-C

The didDismissHandler block has the following parameters:

LCQDismissType

Returns how the SDK was dismissed. It can be set to one of the three following possibilities:

Swift

//Indicates that the issue was submitted and will be uploaded
submit
//Indicates that the user closed the Luciq view without report submission  
cancel

Objective-C

LCQReportCategory

The type of report that was sent. If the SDK was dismissed without selecting a report type, it will be set to LCQReportCategoryBug, so you might need to check issueState before LCQReportCategory. The possible different types are below:

Swift

bug
feedback
question
other

Objective-C