基本通知には通常、1 つのタイトル、1 行のテキスト、レスポンスとしてユーザーが実行可能な 1 つまたは複数のアクションが表示されます。詳細な情報を提供したい場合は、このページで説明している通知テンプレートのいずれかを適用して、大型の展開可能型通知を作成してください。
はじめに、通知を作成するで説明しているように、基本的なコンテンツをすべて含めた通知を作成します。次に、以下に示すように、スタイル オブジェクトを指定して setStyle()
を呼び出し、各テンプレートに対応する情報を指定します。
大きな画像を追加する
通知に画像を追加するには、NotificationCompat.BigPictureStyle
のインスタンスを setStyle()
に渡します。
Kotlin
var notification = NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_post) .setContentTitle(imageTitle) .setContentText(imageDescription) .setStyle(NotificationCompat.BigPictureStyle() .bigPicture(myBitmap)) .build()
Java
Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_post) .setContentTitle(imageTitle) .setContentText(imageDescription) .setStyle(new NotificationCompat.BigPictureStyle() .bigPicture(myBitmap)) .build();
通知が折りたたまれているときはサムネイルだけを表示するには(図 1 を参照)、setLargeIcon()
を呼び出して画像を渡します。さらに BigPictureStyle.bigLargeIcon()
も呼び出して null
を渡し、通知が展開されたときにサムネイルが表示されないようにします。
Kotlin
var notification = NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_post) .setContentTitle(imageTitle) .setContentText(imageDescription) .setLargeIcon(myBitmap) .setStyle(NotificationCompat.BigPictureStyle() .bigPicture(myBitmap) .bigLargeIcon(null)) .build()
Java
Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_post) .setContentTitle(imageTitle) .setContentText(imageDescription) .setLargeIcon(myBitmap) .setStyle(new NotificationCompat.BigPictureStyle() .bigPicture(myBitmap) .bigLargeIcon(null)) .build();
図 1: NotificationCompat.BigPictureStyle
を使用した通知
大きなテキスト ブロックを追加する
NotificationCompat.BigTextStyle
を適用すると、通知の展開コンテンツ領域にテキストを表示できます。
Kotlin
var notification = NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_mail) .setContentTitle(emailObject.getSenderName()) .setContentText(emailObject.getSubject()) .setLargeIcon(emailObject.getSenderAvatar()) .setStyle(NotificationCompat.BigTextStyle() .bigText(emailObject.getSubjectAndSnippet())) .build()
Java
Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_mail) .setContentTitle(emailObject.getSenderName()) .setContentText(emailObject.getSubject()) .setLargeIcon(emailObject.getSenderAvatar()) .setStyle(new NotificationCompat.BigTextStyle() .bigText(emailObject.getSubjectAndSnippet())) .build();
図 2: NotificationCompat.BigTextStyle
を使用した通知
ヒント: テキストのフォーマット(太字、斜体、改行など)を指定するには、HTML マークアップを使用してスタイル設定を追加します。
受信トレイスタイルの通知を作成する
NotificationCompat.InboxStyle
を通知に適用すると、受信メールの抜粋など、数行の簡潔な概要を追加することができます。これにより、NotificationCompat.BigTextStyle
が提供する連続テキスト行ではなく、複数のコンテンツ テキストからそれぞれ 1 行だけの抜粋を表示することができます。
新しい行を追加する場合、addLine()
を最大 6 回呼び出すことができます。6 行を超える行を追加しても、最初の 6 行しか表示されません。
Kotlin
var notification = NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_mail) .setContentTitle("5 New mails from " + sender.toString()) .setContentText(subject) .setLargeIcon(aBitmap) .setStyle(NotificationCompat.InboxStyle() .addLine(messageSnippet1) .addLine(messageSnippet2)) .build()
Java
Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_mail) .setContentTitle("5 New mails from " + sender.toString()) .setContentText(subject) .setLargeIcon(aBitmap) .setStyle(new NotificationCompat.InboxStyle() .addLine(messageSnippet1) .addLine(messageSnippet2)) .build();
ヒント: 各行内でメッセージの件名とメッセージ本文を区別するには、HTML マークアップを使用してスタイル設定を追加します(たとえば、件名を太字にします)。
通知に会話を表示する
NotificationCompat.MessagingStyle
を適用すると、さまざまな人から受信したメッセージ グループを表示できます。人数の制限はありません。一貫したレイアウトで各メッセージを表示できるため、メッセージ アプリに最適です。この場合、送信者の名前とメッセージ テキストを別々に扱い、各メッセージを複数行に渡って表示することができます。
新しいメッセージを追加するには、addMessage()
を呼び出して、メッセージ テキスト、受信日時、送信者名を渡します。この情報を NotificationCompat.MessagingStyle.Message
オブジェクトとして渡すこともできます。
Kotlin
var message1 = NotificationCompat.MessagingStyle.Message(messages[0].getText(), messages[0].getTime(), messages[0].getSender()) var message2 = NotificationCompat.MessagingStyle.Message(messages[1].getText(), messages[1].getTime(), messages[1].getSender()) var notification = NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_message) .setStyle(NotificationCompat.MessagingStyle(resources.getString(R.string.reply_name)) .addMessage(message1) .addMessage(message2)) .build()
Java
NotificationCompat.MessagingStyle.Message message1 = new NotificationCompat.MessagingStyle.Message(messages[0].getText(), messages[0].getTime(), messages[0].getSender()); NotificationCompat.MessagingStyle.Message message2 = new NotificationCompat.MessagingStyle.Message(messages[1].getText(), messages[1].getTime(), messages[1].getSender()); Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) .setSmallIcon(R.drawable.new_message) .setStyle(new NotificationCompat.MessagingStyle(resources.getString(R.string.reply_name)) .addMessage(message1) .addMessage(message2)) .build();
図 3: NotificationCompat.MessagingStyle
を使用した通知
必要に応じて、setConversationTitle()
を呼び出すことで、会話の上部に表示するタイトルを追加できます。タイトルには、ユーザーが作成したグループ名を指定できます。また、特に名前を付けない場合は、会話の参加者のリストなどをタイトルにすることもできます。1 対 1 のチャットの場合は、会話タイトルを設定しないでください。このフィールドは、会話がグループかどうかを判断するヒントとして使用されます。
このスタイルが適用されるのは、Android 7.0(API レベル 24)以降を搭載しているデバイスに限られます。上記の例のように互換性ライブラリ(NotificationCompat
)を使用した場合、MessagingStyle を指定した通知には、サポートされている展開サイズ通知スタイルが代替的に自動適用されます。
チャットの会話を対象としてこのような通知を作成する場合は、ダイレクト返信アクションを追加することも必要になります。
メディア コントロールを備えた通知を作成する
NotificationCompat.MediaStyle
を適用すると、メディア再生コントロールとトラック情報を表示できます。
addAction()
を最大 5 回呼び出すことで、最大 5 つのアイコンボタンを表示できます。アルバムのアートワークを設定する場合は、setLargeIcon()
を呼び出します。
他の通知スタイルとは異なり、MediaStyle を使用すると、折りたたみサイズ コンテンツ ビューも編集可能になり、3 つの操作ボタンも表示するように指定できます(このボタンは、折りたたみビューにも表示できます)。そのためには、操作ボタンのインデックスを setShowActionsInCompactView()
に指定します。
通知がアクティブなメディア セッションを示す場合は、setMediaSession()
を使用して、MediaSession.Token
を通知にアタッチします。Android は、これをアクティブなメディア セッションを示す通知として識別し、それに応じて処理します(たとえば、ロック画面にアルバムのアートワークを表示します)。
Kotlin
import android.support.v4.app.NotificationCompat import android.support.v4.media.app.NotificationCompat as MediaNotificationCompat var notification = NotificationCompat.Builder(context, CHANNEL_ID) // Show controls on lock screen even when user hides sensitive content. .setVisibility(NotificationCompat.VISIBILITY_PUBLIC) .setSmallIcon(R.drawable.ic_stat_player) // Add media control buttons that invoke intents in your media service .addAction(R.drawable.ic_prev, "Previous", prevPendingIntent) // #0 .addAction(R.drawable.ic_pause, "Pause", pausePendingIntent) // #1 .addAction(R.drawable.ic_next, "Next", nextPendingIntent) // #2 // Apply the media style template .setStyle(MediaNotificationCompat.MediaStyle() .setShowActionsInCompactView(1 /* #1: pause button \*/) .setMediaSession(mediaSession.getSessionToken())) .setContentTitle("Wonderful music") .setContentText("My Awesome Band") .setLargeIcon(albumArtBitmap) .build()
Java
Notification notification = new NotificationCompat.Builder(context, CHANNEL_ID) // Show controls on lock screen even when user hides sensitive content. .setVisibility(NotificationCompat.VISIBILITY_PUBLIC) .setSmallIcon(R.drawable.ic_stat_player) // Add media control buttons that invoke intents in your media service .addAction(R.drawable.ic_prev, "Previous", prevPendingIntent) // #0 .addAction(R.drawable.ic_pause, "Pause", pausePendingIntent) // #1 .addAction(R.drawable.ic_next, "Next", nextPendingIntent) // #2 // Apply the media style template .setStyle(new android.support.v4.media.app.Notification.MediaStyle() .setShowActionsInCompactView(1 /* #1: pause button */) .setMediaSession(mediaSession.getSessionToken())) .setContentTitle("Wonderful music") .setContentText("My Awesome Band") .setLargeIcon(albumArtBitmap) .build();
図 4: NotificationCompat.MediaStyle
を使用した通知
関連情報については、フォアグラウンド サービスで MediaStyle 通知を使用するをご覧ください。通知を使用するサンプルコードについては、Android 通知サンプルをご覧ください。