> For the complete documentation index, see [llms.txt](https://docs.luciq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.luciq.ai/ios/setup-luciq-for-ios/setup-bug-reporting/bug-reporting-callbacks.md).

# 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.

{% tabs %}
{% tab title="Swift" %}
{% code overflow="wrap" %}

```swift
BugReporting.willInvokeHandler = {
    someObject.setSomeState()
}
```

{% endcode %}
{% endtab %}

{% tab title="Objective-C" %}
{% code overflow="wrap" %}

```objectivec
LCQBugReporting.willInvokeHandler = ^{
    [someObject setSomeState];
};
```

{% endcode %}
{% endtab %}
{% endtabs %}

### Before Sending a Report

By default, no pre-sending handler is registered. In Luciq iOS SDK 19.12.0 and later, use `onBeforeSendingEventHandler` to add tags, user attributes, user data, and file attachments before a report is sent. Changes to the event apply only to that report.

Register the handler after starting Luciq. It runs in the background; keep your work brief. Call `completion(event)` once when you finish modifying the event. Do not dispatch the completion block to the main queue.

{% hint style="warning" %}
`willSendReportHandler` is deprecated as of iOS SDK 19.12.0. It still works but will be removed in a future release. Migrate to `onBeforeSendingEventHandler` and call the completion block instead of returning a report.
{% endhint %}

{% tabs %}
{% tab title="Swift" %}
{% code overflow="wrap" %}

```swift
Luciq.onBeforeSendingEventHandler = { event, completion in
    event.append(tags: ["checkout"])
    event.append(userAttributes: ["subscription": "premium"])
    event.set(userData: "Checkout context")
    let data = Data("Report context".utf8)
    event.addFileAttachment(data: data, fileName: "context.txt")
    completion(event)
}
```

{% endcode %}
{% endtab %}

{% tab title="Objective-C" %}
{% code overflow="wrap" %}

```objectivec
Luciq.onBeforeSendingEventHandler = ^(LCQEvent *event, void (^completion)(LCQEvent * _Nullable)) {
    [event appendTags:@[@"checkout"]];
    [event appendUserAttributes:@{@"subscription": @"premium"}];
    [event setUserData:@"Checkout context"];
    NSData *data = [@"Report context" dataUsingEncoding:NSUTF8StringEncoding];
    [event addFileAttachmentWithData:data fileName:@"context.txt"];
    completion(event);
};
```

{% endcode %}
{% endtab %}
{% endtabs %}

The new handler receives an `Event` in Swift (`LCQEvent` in Objective-C). Use the event methods shown above for report data; the legacy report logging methods are not available on the event.

Use only one pre-sending API. Setting either `onBeforeSendingEventHandler` or `willSendReportHandler` replaces the other handler; setting either property to `nil` clears the registered handler.

### 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.

{% tabs %}
{% tab title="Swift" %}
{% code overflow="wrap" %}

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

{% endcode %}
{% endtab %}

{% tab title="Objective-C" %}
{% code overflow="wrap" %}

```objectivec
LCQBugReporting.didDismissHandler = ^(LCQDismissType dismissType, LCQReportCategory reportType) {
    [someObject setSomeState];
};
```

{% endcode %}
{% endtab %}
{% endtabs %}

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:

{% tabs %}
{% tab title="Swift" %}
{% code overflow="wrap" %}

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

{% endcode %}
{% endtab %}

{% tab title="Objective-C" %}
{% code overflow="wrap" %}

```objectivec
//Indicates that the issue was submitted and will be uploaded
LCQDismissTypeSubmit
//Indicates that the user closed the Luciq view without report submission  
LCQDismissTypeCancel
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### `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:

{% tabs %}
{% tab title="Swift" %}
{% code overflow="wrap" %}

```swift
bug
feedback
question
other
```

{% endcode %}
{% endtab %}

{% tab title="Objective-C" %}
{% code overflow="wrap" %}

```objectivec
LCQReportCategoryBug
LCQReportCategoryFeedback
LCQReportCategoryQuestion
LCQReportCategoryOther
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.luciq.ai/ios/setup-luciq-for-ios/setup-bug-reporting/bug-reporting-callbacks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
