> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# アプリ内ポップアップのイベントリスナー

> Notifly SDKでアプリ内ポップアップのイベントを検知して処理する方法を説明します。

Notifly SDKは、アプリ内ポップアップのイベントを検知して処理するイベントリスナーを提供します。ユーザーがポップアップで操作したときに、アプリ内で追加の処理を実行できます。

> [tab] Android
>
> > [!NOTE]
> >
> > この機能はNotifly Android SDK 1.16.1以降で利用できます。
>
> ```kotlin theme={null}
>   package com.your.project
>
>   import android.app.Application
>   import android.util.Log
>   import androidx.core.app.NotificationCompat
>   import androidx.core.content.ContextCompat
>   import tech.notifly.Notifly
>   import tech.notifly.push.interfaces.IInAppMessageEventListener
>
>   class SampleApplication : Application() {
>       override fun onCreate() {
>           super.onCreate()
>
>           // Notifly SDKを初期化します
>           Notifly.initialize(
>               context = applicationContext,
>               projectId = BuildConfig.NOTIFLY_PROJECT_ID,
>               username = BuildConfig.NOTIFLY_USERNAME,
>               // passwordは後方互換性のためのプレースホルダーです。実際のパスワードやAPI Secret Keyを設定しないでください。
>               password = BuildConfig.NOTIFLY_USERNAME,
>           )
>
>           // Notiflyのアプリ内メッセージイベントリスナーを登録します
>           Notifly.addInAppMessageEventListener(
>               object : IInAppMessageEventListener {
>                   override fun handleEvent(
>                       eventName: String,
>                       eventParams: Map<String, Any?>?,
>                   ) {
>                       Log.d("SampleApplication", "InAppMessage event dispatched: $eventName, $eventParams")
>                   }
>               },
>           )
>       }
>   }
> ```

> [tab] iOS
>
> > [!NOTE]
> >
> > この機能はNotifly iOS SDK 1.16.1以降で利用できます。
>
> ```swift theme={null}
> import Firebase
> import notifly_sdk
> import UIKit
> import UserNotifications
>
> @main
> class AppDelegate: UIResponder, UIApplicationDelegate {
>     func application(
>         _: UIApplication,
>         didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]?
>     ) -> Bool {
>         ...
>         Notifly.initialize(
>             projectId: TestConstant.projectId, username: TestConstant.username,
>             // passwordは後方互換性のためのプレースホルダーです。実際のパスワードやAPI Secret Keyを設定しないでください。
>             password: TestConstant.username)
>
>         Notifly.addInAppMessageEventListener { eventName, eventParams in
>             print("In App Message Event: \(eventName)")
>             if let params = eventParams {
>                 print("In App Message Event Params: \(params)")
>             }
>         }
>         ...
>         return true
>     }
> }
> ```

> [tab] Flutter
>
> > [!NOTE]
> >
> > この機能はNotifly Flutter SDK 2.1.0以降で利用できます。イベントストリームはAndroidとiOSで利用でき、Webには対応していません。
>
> ```dart theme={null}
> import 'package:flutter/material.dart';
> import 'package:notifly_flutter/notifly_flutter.dart';
> import 'dart:async';
>
> class MyApp extends StatefulWidget {
>  const MyApp({super.key});
>
>  @override
>  State<MyApp> createState() => _MyAppState();
> }
>
> class _MyAppState extends State<MyApp> {
>  StreamSubscription<InAppMessageEvent>? _subscription;
>
>  @override
>  void initState() {
>    super.initState();
>    _initNotifly();
>  }
>
>  Future<void> _initNotifly() async {
>    // Notifly SDKを初期化します
>    await NotiflyPlugin.initialize(
>      projectId: 'YOUR_PROJECT_ID',
>      username: 'YOUR_USERNAME',
>      // `password`は後方互換性のためのプレースホルダーです。実際のパスワードやAPI Secret Keyを設定しないでください。
>      password: 'YOUR_USERNAME',
>    );
>
>    // アプリ内メッセージのイベントを購読します
>    _subscription = NotiflyPlugin.inAppEvents.listen(
>      (event) {
>        print('InAppMessage event dispatched: ${event.eventName}');
>        print('Event params: ${event.eventParams}');
>
>        // イベントに応じた処理を実行します
>        switch (event.eventName) {
>          case 'main_button_click':
>            // メインボタンのタップを処理します
>            break;
>          case 'close_button_click':
>            // 閉じるボタンのタップを処理します
>            break;
>        }
>      },
>      onError: (error, stackTrace) {
>        print('InAppMessage event error: $error');
>        print('Stack trace: $stackTrace');
>      },
>      cancelOnError: false, // エラーが発生しても購読を続けます
>    );
>  }
>
>  @override
>  void dispose() {
>    _subscription?.cancel();
>    super.dispose();
>  }
>
>  @override
>  Widget build(BuildContext context) {
>    return MaterialApp(
>      home: Scaffold(
>        appBar: AppBar(title: const Text('Notifly Sample')),
>        body: const Center(child: Text('Notifly Initialized')),
>      ),
>    );
>  }
> }
> ```

> [tab] React Native
>
> > [!NOTE]
> >
> > この機能は、Notifly React Native SDK 4.6.0以降でAndroidとiOSに対応しています。
>
> 次の例のように、SDKを初期化してからアプリ内ポップアップのイベントリスナーを登録してください。
>
> ```typescript theme={null}
> import notifly from 'notifly-sdk';
>
> export async function initNotifly() {
>   await notifly.initialize({
>     projectId: 'YOUR_PROJECT_ID',
>     username: 'YOUR_USERNAME',
>     // `password`は後方互換性のためのプレースホルダーです。実際のパスワードやAPI Secret Keyを入力しないでください。
>     password: 'YOUR_USERNAME',
>   });
>
>   const subscription = notifly.addInAppMessageEventListener((event) => {
>     console.log('InAppMessage event dispatched:', event.eventName);
>   });
>
>   return subscription;
> }
> ```
>
> アプリの初期化コードで`await initNotifly()`が返す購読オブジェクトを保持し、イベントを受信する必要がなくなったら`subscription.remove()`を呼び出してください。ポップアップを表示する前に登録します。登録前に発生したイベントは再送されません。

## アプリ内ポップアップのイベントリスナーのインターフェース

> [tab] Android
>
> `IInAppMessageEventListener`の`handleEvent`メソッドを実装すると、アプリ内ポップアップのイベントを検知できます。次のパラメーターを受け取ります。
>
> **eventName** `String`
>
> 発生したイベントの名前です。
>
> **eventParams** `Map\<String, Any?\>?`
>
> イベントに関する追加情報です。パラメーターがない場合は`null`になります。

> [tab] iOS
>
> `addInAppMessageEventListener`で`InAppMessageEventListener`を登録できます。
>
> **eventName** `String`
>
> 発生したイベントの名前です。
>
> **eventParams** `[String: Any]?`
>
> イベントに関する追加情報です。パラメーターがない場合は`nil`になります。

> [tab] Flutter
>
> `NotiflyPlugin.inAppEvents`ストリームでアプリ内ポップアップのイベントを購読できます。各イベントは、次のプロパティを持つ`InAppMessageEvent`オブジェクトとして渡されます。
>
> **eventName** `String`
>
> 発生したイベントの名前です。
>
> **eventParams** `Map\<String, dynamic\>?`
>
> イベントに関する追加情報です。パラメーターがない場合は`null`になります。

> [tab] React Native
>
> `notifly.addInAppMessageEventListener`でアプリ内ポップアップのイベントを購読できます。各イベントは、次のプロパティを持つ`InAppMessageEvent`オブジェクトとして渡されます。
>
> **eventName** `string`
>
> 発生したイベントの名前です。
>
> **eventParams** `Record\<string, unknown\> | null`
>
> イベントに関する追加情報です。値はイベントとプラットフォームによって異なり、パラメーターがない場合は`null`になります。

## アプリ内ポップアップのイベント一覧

> [tab] Android
>
> `handleEvent`に渡される`eventName`の一覧です。
>
> * `in_app_message_show`は、アプリ内ポップアップが表示されたときに発生します。
> * `main_button_click`は、ポップアップのメインボタンがタップされたときに発生します。
> * `hide_in_app_message_button_click`は、「再表示しない」ボタンがタップされたときに発生します。
> * `close_button_click`は、ポップアップの閉じるボタンがタップされたときに発生します。
> * `survey_submit_button_click`は、アンケートの送信ボタンがタップされたときに発生します。

> [tab] iOS
>
> `addInAppMessageEventListener`に渡される`eventName`の一覧です。
>
> * `in_app_message_show`は、アプリ内ポップアップが表示されたときに発生します。
> * `main_button_click`は、ポップアップのメインボタンがタップされたときに発生します。
> * `hide_in_app_message_button_click`は、「再表示しない」ボタンがタップされたときに発生します。
> * `close_button_click`は、ポップアップの閉じるボタンがタップされたときに発生します。
> * `survey_submit_button_click`は、アンケートの送信ボタンがタップされたときに発生します。

> [tab] Flutter
>
> `NotiflyPlugin.inAppEvents`で渡される`eventName`の一覧です。
>
> * `in_app_message_show`は、アプリ内ポップアップが表示されたときに発生します。
> * `main_button_click`は、ポップアップのメインボタンがタップされたときに発生します。
> * `hide_in_app_message_button_click`は、「再表示しない」ボタンがタップされたときに発生します。
> * `close_button_click`は、ポップアップの閉じるボタンがタップされたときに発生します。
> * `survey_submit_button_click`は、アンケートの送信ボタンがタップされたときに発生します。

> [tab] React Native
>
> `notifly.addInAppMessageEventListener`に渡される`eventName`の一覧です。
>
> * `in_app_message_show`: アプリ内ポップアップの表示イベント。
>
> * `main_button_click`: ポップアップのメインボタンがタップされたときに発生します。
>
> * `hide_in_app_message_button_click`: 「再表示しない」ボタンがタップされたときに発生します。
>
> * `close_button_click`: ポップアップの閉じるボタンがタップされたときに発生します。
>
> * `survey_submit_button_click`: アンケートの送信ボタンがタップされたときに発生します。
>
> > [!NOTE]
> >
> > React Native SDK 4.6.0に含まれるAndroid SDK 1.24.3には、アンケートの`extra_data`に`link`フィールドがない場合、`survey_submit_button_click`が通知されない既存の問題があります。iOSでは同じ条件でもイベントが通知されます。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.