InboxStyle

Kotlin |Java

open class InboxStyle : NotificationCompat.Style

kotlin.Any
↳	androidx.core.app.NotificationCompat.Style
	↳	androidx.core.app.NotificationCompat.InboxStyle

Helper class for generating large-format notifications that include a list of (up to 5) strings.
If the platform does not provide large-format notifications, this method has no effect. The user will always see the normal notification view.
This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:

Notification notification = new Notification.Builder()
          .setContentTitle("5 New mails from " + sender.toString())
          .setContentText(subject)
          .setSmallIcon(R.drawable.new_mail)
          .setLargeIcon(aBitmap)
          .setStyle(new Notification.InboxStyle()
              .addLine(str1)
              .addLine(str2)
              .setContentTitle("")
              .setSummaryText("+3 more"))
          .build();
      

Summary

Public constructors
<init>()
<init>(@Nullable builder: NotificationCompat.Builder?)

Public methods
open NotificationCompat.InboxStyle	addLine(@Nullable cs: CharSequence?) Append a line to the digest section of the Inbox notification.
open NotificationCompat.InboxStyle	setBigContentTitle(@Nullable title: CharSequence?) Overrides ContentTitle in the big form of the template.
open NotificationCompat.InboxStyle	setSummaryText(@Nullable cs: CharSequence?) Set the first line of text after the detail section in the big form of the template.

Inherited functions
From class Style Notification? build() If this Style object has been set on a notification builder, this method will build that notification and return it. Otherwise, it will return null. Unit setBuilder(@Nullable builder: NotificationCompat.Builder?) Link this rich notification style with a notification builder.

Public constructors

<init>

InboxStyle()

<init>

InboxStyle(@Nullable builder: NotificationCompat.Builder?)

Public methods

addLine

@NonNull open fun addLine(@Nullable cs: CharSequence?): NotificationCompat.InboxStyle

Append a line to the digest section of the Inbox notification.

setBigContentTitle

@NonNull open fun setBigContentTitle(@Nullable title: CharSequence?): NotificationCompat.InboxStyle

Overrides ContentTitle in the big form of the template. This defaults to the value passed to setContentTitle().

setSummaryText

@NonNull open fun setSummaryText(@Nullable cs: CharSequence?): NotificationCompat.InboxStyle

Set the first line of text after the detail section in the big form of the template.