NotificationCompat.InboxStyle

Added in 1.1.0

Kotlin |Java

public class NotificationCompat.InboxStyle extends NotificationCompat.Style

java.lang.Object
↳	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();

See also
`bigContentView`

Summary

Public constructors
`InboxStyle()`
`InboxStyle(@Nullable NotificationCompat.Builder builder)`

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

Inherited methods

From androidx.core.app.NotificationCompat.Style

`@Nullable Notification`	`build()` If this Style object has been set on a notification builder, this method will build that notification and return it.
`void`	`setBuilder(@Nullable NotificationCompat.Builder builder)` Link this rich notification style with a notification builder.

Public constructors

InboxStyle

Added in 1.1.0

public InboxStyle()

InboxStyle

Added in 1.1.0

public InboxStyle(@Nullable NotificationCompat.Builder builder)

Public methods

addLine

Added in 1.1.0

public @NonNull NotificationCompat.InboxStyle addLine(@Nullable CharSequence cs)

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

setBigContentTitle

Added in 1.1.0

public @NonNull NotificationCompat.InboxStyle setBigContentTitle(@Nullable CharSequence title)

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

setSummaryText

Added in 1.1.0

public @NonNull NotificationCompat.InboxStyle setSummaryText(@Nullable CharSequence cs)

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