---
title: "Обработка событий онбординга в Android SDK"
description: "Обработка событий онбординга в Android с помощью Adapty."
---

Перед началом убедитесь, что:

1. Вы установили [Adapty Android SDK](sdk-installation-android) версии 3.8.0 или выше.
2. Вы [создали онбординг](create-onboarding).
3. Вы добавили онбординг в [плейсмент](placements).

Онбординги, настроенные с помощью билдера, генерируют события, на которые может реагировать ваше приложение. Ниже описано, как с ними работать.

Чтобы управлять процессами на экране онбординга и отслеживать их в Android-приложении, реализуйте интерфейс `AdaptyOnboardingEventListener`.

## Пользовательские действия \{#custom-actions\}

В билдере можно добавить к кнопке действие **custom** и назначить ему ID. Затем этот ID можно использовать в коде и обрабатывать как пользовательское действие.

  <img src="/assets/shared/img/ios-events-1.webp"
  style={{
    border: '1px solid #727272', /* border width and color */
    width: '700px', /* image width */
    display: 'block', /* for alignment */
    margin: '0 auto' /* center alignment */
  }}
/>

Например, если пользователь нажимает на кнопку с пользовательским действием — например, **Login** или **Allow notifications** — будет вызван метод делегата `onCustomAction` с ID действия из билдера. Вы можете задавать собственные ID, например "allowNotifications".

```kotlin showLineNumbers
class YourActivity : AppCompatActivity() {
    private val eventListener = object : AdaptyOnboardingEventListener {
        override fun onCustomAction(action: AdaptyOnboardingCustomAction, context: Context) {
            when (action.actionId) {
                "allowNotifications" -> {
                    // Request notification permissions
                }
            }
        }
        
        override fun onError(error: AdaptyOnboardingError, context: Context) {
            // Handle errors
        }
        
        // ... other required delegate methods
    }
}
```

<Details>
<summary>Пример события (нажмите, чтобы раскрыть)</summary>

```json
{
  "actionId": "allowNotifications",
  "meta": {
    "onboardingId": "onboarding_123",
    "screenClientId": "profile_screen",
    "screenIndex": 0,
    "screensTotal": 3
  }
}
```
</Details>

## Закрытие онбординга \{#closing-onboarding\}

Онбординг считается закрытым, когда пользователь нажимает кнопку с назначенным действием **Close**. Вам нужно определить, что происходит при закрытии онбординга. Например:

:::important
Вам нужно управлять тем, что происходит при закрытии онбординга. В частности, необходимо прекратить отображение самого онбординга.
:::

Например:

```kotlin
override fun onCloseAction(action: AdaptyOnboardingCloseAction, context: Context) {
    // Dismiss the onboarding screen
    (context as? Activity)?.onBackPressed()
}
```

<Details>
<summary>Пример события (нажмите, чтобы раскрыть)</summary>

```json
{
  "action_id": "close_button",
  "meta": {
    "onboarding_id": "onboarding_123",
    "screen_cid": "final_screen",
    "screen_index": 3,
    "total_screens": 4
  }
}
```

</Details>

## Открытие пейвола \{#opening-a-paywall\}

:::tip
Обрабатывайте это событие, если хотите открыть пейвол внутри онбординга. Если вы хотите открыть пейвол после закрытия онбординга, есть более простой способ — обработайте [`AdaptyOnboardingCloseAction`](#closing-onboarding) и откройте пейвол без использования данных события.
:::

Если пользователь нажимает кнопку, открывающую пейвол, вы получите ID действия кнопки, который вы [настроили вручную](get-paid-in-onboardings). Самый удобный способ работы с пейволами в онбордингах — сделать ID действия равным ID плейсмента пейвола. Тогда после события `AdaptyOnboardingOpenPaywallAction` вы сможете использовать ID плейсмента, чтобы сразу получить и открыть пейвол:

```kotlin
override fun onOpenPaywallAction(action: AdaptyOnboardingOpenPaywallAction, context: Context) {
    // Get the paywall using the placement ID from the action
    Adapty.getPaywall(placementId = action.actionId) { result ->
        when (result) {
            is AdaptyResult.Success -> {
                val paywall = result.value
                // Get the paywall configuration
                AdaptyUI.getViewConfiguration(paywall) { result ->
                    when(result) {
                        is AdaptyResult.Success -> {
                            val paywallConfig = result.value
                            // Create and present the paywall
                            val paywallView = AdaptyUI.getPaywallView(
                                activity = this,
                                viewConfig = paywallConfig,
                                products,
                                eventListener = paywallEventListener
                            )
                            // Add the paywall view to your layout
                            binding.container.addView(paywallView)
                        }
                        is AdaptyResult.Error -> {
                            val error = result.error
                            // handle the error
                        }
                    }
                }
            is AdaptyResult.Error -> {
                val error = result.error
                // handle the error
            }        
        }
    }
}
```

<Details>
<summary>Пример события (нажмите, чтобы раскрыть)</summary>

```json
{
    "action_id": "premium_offer_1",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "pricing_screen",
        "screen_index": 2,
        "total_screens": 4
    }
}
```

</Details>

## Завершение загрузки онбординга \{#finishing-loading-onboarding\}

Когда онбординг завершает загрузку, вызывается этот метод:

```kotlin
override fun onFinishLoading(action: AdaptyOnboardingLoadedAction, context: Context) {
    // Handle loading completion
}
```

<Details>
<summary>Пример события (нажмите, чтобы раскрыть)</summary>

```json
{
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "welcome_screen",
        "screen_index": 0,
        "total_screens": 4
    }
}
```

</Details>

## События навигации \{#navigation-events\}

Метод `onAnalyticsEvent` вызывается при возникновении различных аналитических событий в процессе онбординга.

Объект `event` может быть одного из следующих типов:
| Тип | Описание |
|------------|-------------|
| `OnboardingStarted` | Онбординг загружен |
| `ScreenPresented` | Отображён любой экран |
| `ScreenCompleted` | Экран завершён. Включает необязательный `elementId` (идентификатор завершённого элемента) и необязательный `reply` (ответ пользователя). Срабатывает, когда пользователь выполняет любое действие для выхода с экрана. |
| `SecondScreenPresented` | Отображён второй экран |
| `UserEmailCollected` | Срабатывает, когда email пользователя получен через поле ввода |
| `OnboardingCompleted` | Срабатывает, когда пользователь достигает экрана с ID `final`. Если вам нужно это событие, назначьте ID `final` последнему экрану. |
| `Unknown` | Для любого нераспознанного типа события. Включает `name` (название неизвестного события) и `meta` (дополнительные метаданные) |

Каждое событие содержит информацию `meta`:
| Поле | Описание |
|------------|-------------|
| `onboardingId` | Уникальный идентификатор онбординга |
| `screenClientId` | Идентификатор текущего экрана |
| `screenIndex` | Позиция текущего экрана в потоке |
| `totalScreens` | Общее количество экранов |

Пример использования аналитических событий для отслеживания:

```kotlin
override fun onAnalyticsEvent(event: AdaptyOnboardingAnalyticsEvent, context: Context) {
    when (event) {
        is AdaptyOnboardingAnalyticsEvent.OnboardingStarted -> {
            // Track onboarding start
            trackEvent("onboarding_started", event.meta)
        }
        is AdaptyOnboardingAnalyticsEvent.ScreenPresented -> {
            // Track screen presentation
            trackEvent("screen_presented", event.meta)
        }
        is AdaptyOnboardingAnalyticsEvent.ScreenCompleted -> {
            // Track screen completion with user response
            trackEvent("screen_completed", event.meta, event.elementId, event.reply)
        }
        is AdaptyOnboardingAnalyticsEvent.OnboardingCompleted -> {
            // Track successful onboarding completion
            trackEvent("onboarding_completed", event.meta)
        }
        is AdaptyOnboardingAnalyticsEvent.Unknown -> {
            // Handle unknown events
            trackEvent(event.name, event.meta)
        }
        // Handle other cases as needed
    }
}
``` 

<Details>
<summary>Примеры событий (нажмите, чтобы раскрыть)</summary>

```javascript
// OnboardingStarted
{
  "name": "onboarding_started",
  "meta": {
    "onboarding_id": "onboarding_123",
    "screen_cid": "welcome_screen",
    "screen_index": 0,
    "total_screens": 4
  }
}

// ScreenPresented

{
    "name": "screen_presented",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "interests_screen",
        "screen_index": 2,
        "total_screens": 4
    }
}

// ScreenCompleted

{
    "name": "screen_completed",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "profile_screen",
        "screen_index": 1,
        "total_screens": 4
    },
    "params": {
        "element_id": "profile_form",
        "reply": "success"
    }
}

// SecondScreenPresented

{
    "name": "second_screen_presented",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "profile_screen",
        "screen_index": 1,
        "total_screens": 4
    }
}

// UserEmailCollected

{
    "name": "user_email_collected",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "profile_screen",
        "screen_index": 1,
        "total_screens": 4
    }
}

// OnboardingCompleted

{
    "name": "onboarding_completed",
    "meta": {
        "onboarding_id": "onboarding_123",
        "screen_cid": "final_screen",
        "screen_index": 3,
        "total_screens": 4
    }
}

```

</Details>