BigPictureStyle

Kotlin |Java

open class BigPictureStyle : NotificationCompat.Style

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

Helper class for generating large-format notifications that include a large image attachment.
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(mContext)
          .setContentTitle("New photo from " + sender.toString())
          .setContentText(subject)
          .setSmallIcon(R.drawable.new_post)
          .setLargeIcon(aBitmap)
          .setStyle(new Notification.BigPictureStyle()
              .bigPicture(aBigBitmap))
          .build();

Summary

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

Public methods
open NotificationCompat.BigPictureStyle	`bigLargeIcon(@Nullable b: Bitmap?)` Override the large icon when the big notification is shown.
open NotificationCompat.BigPictureStyle	`bigPicture(@Nullable b: Bitmap?)` Provide the bitmap to be used as the payload for the BigPicture notification.
open NotificationCompat.BigPictureStyle	`setBigContentTitle(@Nullable title: CharSequence?)` Overrides ContentTitle in the big form of the template.
open NotificationCompat.BigPictureStyle	`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>

BigPictureStyle()

<init>

BigPictureStyle(@Nullable builder: NotificationCompat.Builder?)

Public methods

bigLargeIcon

@NonNull open fun bigLargeIcon(@Nullable b: Bitmap?): NotificationCompat.BigPictureStyle

Override the large icon when the big notification is shown.

bigPicture

@NonNull open fun bigPicture(@Nullable b: Bitmap?): NotificationCompat.BigPictureStyle

Provide the bitmap to be used as the payload for the BigPicture notification.

setBigContentTitle

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

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.BigPictureStyle

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