概要

通知センターはプッシュ通知の履歴を表示し、エンドユーザーがスクロールして見逃した通知を確認できるオプションを提供します。MoEngage は、完全にカスタマイズ可能なデフォルト UI を備えたすぐに使える Inbox サポートを提供するほか、独自の通知センターを構築するオプションも提供しています。

MoEngage のデフォルト通知センターを使用する

SDK のインストール

BOM を使用したインストール

BOM を使用した統合が推奨される統合方法です。Install Using BOM ドキュメントを参照してください。BOM を設定したら、以下のように app/build.gradle ファイルに依存関係を追加します。

dependencies {
    ...
    implementation("com.moengage:inbox-ui")
}

BOM を設定したら、アプリケーションに必要な特定の MoEngage モジュールを含めます。
注: これらの依存関係にバージョン番号は不要です。BOM が自動的に管理します。

デフォルトの通知センターをアプリに追加する

デフォルトの通知センター UI を使用するには、SDK が提供する Activity を起動するか、SDK が提供する Fragment を追加します。

Activity を使用する

Activity は SDK のマニフェストファイルですでに宣言されており、以下のコードを使用して起動できます。

//launching the default InboxActivity
val intent = Intent(this, InboxActivity::class.java)
startActivity(intent)

Intent intent = new Intent(this, InboxActivity.class);
startActivity(intent);

Fragment を使用する

SDK が提供する InboxFragment をアプリの Activity に埋め込むことができます。Activity に Fragment を追加する方法については、Fragment に関する Google のドキュメントを参照してください。

Inbox に親 Activity を追加する

必要に応じて、Inbox の親 Activity を定義する場合は、以下のコードを使用します。[PARENT_ACTIVITY_NAME] を親 Activity の名前に置き換えてください。

<activity
    android:name="com.moengage.inbox.ui.view.InboxActivity"
    android:parentActivityName="[PARENT_ACTIVITY_NAME]" />

デフォルト通知センターのカスタマイズ

SDK は一定の UI カスタマイズオプションを提供しています。InboxActivity はすでに SDK のマニフェストファイルに含まれています。デフォルト Activity のラベルやテーマを変更する必要がある場合は、アプリのマニフェストファイルで Activity を再度宣言し、属性を上書きしてください。

Activity ラベルのカスタマイズ

Inbox Activity のデフォルトラベルは Notification Inbox です。アプリケーションの strings.xml で moe_inbox_notification_title を宣言することで上書きできます。

<resources>
  <string name="moe_inbox_notification_title">[LABEL]</string>
</resources>

Activity のテーマ

テーマをカスタマイズするには、アプリのマニフェストで Activity を再宣言して目的のテーマを指定するか、以下で説明するように SDK のデフォルトを上書きします。 InboxActivity に適用されるデフォルトのテーマは MoEInboxTheme.NoActionBar です。アプリケーションの style.xml、themes.xml、または同等のファイルで同じ名前のテーマを宣言できます。以下はデフォルトテーマの定義です。

 <style name="MoEInboxTheme.NoActionBar">
    <item name="colorPrimary">@color/moe_inbox_color_primary</item>
    <item name="colorPrimaryDark">@color/moe_inbox_color_primary_dark</item>
    <item name="colorControlNormal">@color/moe_inbox_control_color</item>
    <item name="android:background">@color/moe_inbox_background_color</item>
  </style>

  <style name="MoETheme.AppBarOverlay" parent="ThemeOverlay.AppCompat.Light" />

  <style name="MoETheme.PopupOverlay" parent="ThemeOverlay.AppCompat.Light"/>
</style>

テーマをカスタマイズするには、アプリケーションの colors.xml ファイルで同じ名前のカラー属性を定義して、任意のカラー属性を上書きします。

{/*   Theme customisation   */}
    <color name="moe_inbox_color_accent">#1C64D0</color>
    <color name="moe_inbox_color_primary_dark">@color/moe_black</color>
    <color name="moe_inbox_color_primary">@color/moe_white</color>
    <color name="moe_inbox_control_color">@color/moe_black</color>

たとえば、プライマリダークカラーをカスタマイズする場合は、以下のようにアプリの colors.xml で moe_inbox_color_primary_dark を定義します。

<color name="moe_inbox_color_primary_dark">[YOUR_COLOR]</color>

同様に、以下をカスタマイズできます。

ツールバーのスタイル
メッセージテキストの外観
- ヘッダー
- メッセージ
- タイムスタンプ
スクロールバーのスタイル
空の通知センターのスタイル

以下の SDK のデフォルト属性を上書きしてテーマをカスタマイズできます。

{/*   Toolbar Text Style */}
<style name="MoEInboxToolbarTextStyle" parent="TextAppearance.Widget.AppCompat.Toolbar.Title">
  <item name="android:textColor">@color/moe_inbox_toolbar_text_color</item>
  <item name="android:fontFamily">@font/roboto</item>
  <item name="android:textSize">@dimen/moe_inbox_tab_font_size</item>
  <item name="android:textStyle">bold</item>
</style>

{/*  Header style  */}
<style name="MoEInboxHeaderTextStyle">
  <item name="android:background">@color/moe_inbox_transparent_color</item>
  <item name="android:textSize">@dimen/moe_inbox_header_font_size</item>
  <item name="android:singleLine">true</item>
  <item name="android:ellipsize">marquee</item>
  <item name="android:textColor">@color/moe_inbox_header_color</item>
  <item name="android:fontFamily">@font/roboto</item>
  <item name="android:textStyle">bold</item>
</style>

{/*  Message style  */}
<style name="MoEInboxMessageTextStyle">
  <item name="android:background">@color/moe_inbox_transparent_color</item>
  <item name="android:textSize">@dimen/moe_inbox_content_font_size</item>
  <item name="android:maxLines">3</item>
  <item name="android:ellipsize">end</item>
  <item name="android:textColor">@color/moe_inbox_message_color</item>
  <item name="android:fontFamily">@font/roboto</item>
</style>

{/*  List Item Separator style  */}
<style name="MoEInboxSeparatorStyle">
  <item name="android:background">@drawable/moe_inbox_item_divider</item>
</style>
    
{/*  Timestamp Style  */}
<style name="MoEInboxTimeTextStyle">
  <item name="android:background">@color/moe_inbox_transparent_color</item>
  <item name="android:textSize">@dimen/moe_inbox_time_font_size</item>
  <item name="android:singleLine">true</item>
  <item name="android:ellipsize">marquee</item>
  <item name="android:textColor">@color/moe_inbox_timestamp_color</item>
  <item name="android:fontFamily">@font/roboto</item>
</style>

{/*   Empty List Style */}
<style name="MoEInboxEmptyBoxTextStyle">
  <item name="android:background">@color/moe_inbox_transparent_color</item>
  <item name="android:textSize">@dimen/moe_inbox_empty_box_text_size</item>
  <item name="android:textColor">@color/moe_inbox_message_color</item>
  <item name="android:fontFamily">@font/roboto</item>
</style>

{/*   Scrollbar style */}
<style name="MoEInboxScrollbarStyle">
  <item name="android:scrollbarAlwaysDrawVerticalTrack">true</item>
  <item name="android:scrollbarStyle">outsideOverlay</item>
  <item name="android:scrollbars">vertical</item>
  <item name="android:fadeScrollbars">true</item>
  <item name="android:scrollbarThumbVertical">@drawable/moe_inbox_vertical_scroller_thumb</item>
  <item name="android:scrollbarSize">30dp</item>
</style>

InboxAdapter のカスタマイズ

InboxAdapter を上書きして、通知アイテムのルックアンドフィールをカスタマイズできます。

カスタムの InboxAdapter を使用する場合、SDK が通知のクリックアクションを処理できるように、アプリはメッセージアイテムのクリック時に必ず InboxListAdapater.onItemClicked() を呼び出す必要があります。呼び出さない場合、クリックイベントはトラッキングされず、クリック時のアクションも実行されません。

カスタム InboxAdapter の準備ができたら、InboxActivity を起動する前に MoEInboxUiHelper でカスタム Adapter を設定します。

MoEInboxUiHelper.getInstance().setInboxAdapter(InboxCustomAdapter())

高度なカスタマイズオプション

通知センターから通知を削除する
deleteItem() を呼び出すことで、通知センターから特定の通知を削除できます。

public fun onBind(position: Int, inboxMessage: InboxMessage, inboxListAdapter: InboxListAdapter) {
  deleteButton.setOnClickListener{
    //Call `deleteItem` method to remove Notification 
    //with item's position and the `InboxMessage` object.
    inboxListAdapter.deleteItem(position, inboxMessage)
    }
}

public void onBind(int position, InboxMessage inboxMessage, InboxListAdapter inboxListAdapter) {
  deleteButton.setOnClickListener(v -> {
    //Call `deleteItem` method to remove Notification 
    //with item's position and the `InboxMessage` object.
    inboxListAdapter.deleteItem(position, inboxMessage);
  });
}

これで、通知が通知センターから削除され、通知センターが更新されます。

通知アイテムのクリックのカスタム処理

デフォルトの通知センターを使用している場合、または InboxAdapter を上書きせずにアプリで InboxFragment を使用している場合、デフォルトでは SDK が通知のクリックアクションを処理しますが、OnMessageClickListener を設定することで、アプリでクリックアクションを処理することもできます。

//set the Message click listener
MoEInboxUiHelper.getInstance().setOnMessageClickListener(listener)
//Remove the Message click listener
MoEInboxUiHelper.getInstance().setOnMessageClickListener(null)

//set the Message click listener
MoEInboxUiHelper.getInstance().setOnMessageClickListener(listener);
//Remove the Message click listener
MoEInboxUiHelper.getInstance().setOnMessageClickListener(null);

セルフハンドリングの通知センター

MoEngage SDK は、表示する Inbox データの取得、イベントのトラッキング、メッセージの削除などを行うヘルパー API を提供しており、これらを使用して独自の通知センターを構築できます。 MavenBadge

SDK のインストール

BOM を使用した統合が推奨される方法です。Install Using BOM を参照してください。BOM を設定したら、app/build.gradle に以下の依存関係を追加します。

dependencies {
    ...
    implementation("com.moengage:inbox-core")
}

この依存関係にバージョン番号は不要です。BOM が管理します。

独自の通知センターを構築する

以下のヘルパー API を使用して、独自の通知センターを構築できます。利用可能なヘルパー API の詳細については、こちらを参照してください。

すべてのメッセージを取得する

// synchronous API should not be called on the main thread
MoEInboxHelper.getInstance().fetchAllMessages(context)
// asynchronous API, where listener is an instance of `OnMessagesAvailableListener`
MoEInboxHelper.getInstance().fetchAllMessagesAsync(applicationContext, listener)

// synchronous API should not be called on the main thread
MoEInboxHelper.getInstance().fetchAllMessages(context);
// asynchronous API, where listener is an instance of `OnMessagesAvailableListener`
MoEInboxHelper.getInstance().fetchAllMessagesAsync(applicationContext, listener);

未クリックの通知数を取得する

MoEInboxHelper.getInstance().getUnClickedMessagesCount(applicationContext)

MoEInboxHelper.getInstance().getUnClickedMessagesCount(applicationContext)

Inbox 通知のクリックをトラッキングする

MoEInboxHelper.getInstance().trackMessageClicked(context, inboxMessage)

MoEInboxHelper.getInstance().trackMessageClicked(context, inboxMessage);

Inbox メッセージを削除する

MoEInboxHelper.getInstance().deleteMessage(context, inboxMessage)

MoEInboxHelper.getInstance().deleteMessage(context, inboxMessage);

すべての Inbox メッセージを削除する

この機能には、最小カタログバージョン 4.5.0 が必要です。

MoEInboxHelper.getInstance().deleteAllMessages(context)

MoEInboxHelper.getInstance().deleteAllMessages(context);

通知にクーポンコードが含まれているかを確認する

MoEInboxHelper.getInstance().hasCouponCode(inboxMessage)

MoEInboxHelper.getInstance().hasCouponCode(inboxMessage);

クーポンコードを取得する

MoEInboxHelper.getInstance().getCouponCode(inboxMessage);

MoEInboxHelper.getInstance().getCouponCode(inboxMessage);

詳細については、API リファレンスを参照してください。

​概要

​MoEngage のデフォルト通知センターを使用する

​SDK のインストール

​BOM を使用したインストール

​デフォルトの通知センターをアプリに追加する

​Activity を使用する

​Fragment を使用する

​Inbox に親 Activity を追加する

​デフォルト通知センターのカスタマイズ

​Activity ラベルのカスタマイズ

​Activity のテーマ

​InboxAdapter のカスタマイズ

​高度なカスタマイズオプション

​セルフハンドリングの通知センター

​SDK のインストール

​独自の通知センターを構築する

​すべてのメッセージを取得する

​未クリックの通知数を取得する

​Inbox 通知のクリックをトラッキングする

​Inbox メッセージを削除する

​すべての Inbox メッセージを削除する

​通知にクーポンコードが含まれているかを確認する

​クーポンコードを取得する

概要

MoEngage のデフォルト通知センターを使用する

SDK のインストール

BOM を使用したインストール

デフォルトの通知センターをアプリに追加する

Activity を使用する

Fragment を使用する

Inbox に親 Activity を追加する

デフォルト通知センターのカスタマイズ

Activity ラベルのカスタマイズ

Activity のテーマ

InboxAdapter のカスタマイズ

高度なカスタマイズオプション

セルフハンドリングの通知センター

SDK のインストール

独自の通知センターを構築する

すべてのメッセージを取得する

未クリックの通知数を取得する

Inbox 通知のクリックをトラッキングする

Inbox メッセージを削除する

すべての Inbox メッセージを削除する

通知にクーポンコードが含まれているかを確認する

クーポンコードを取得する