Notification.BigPictureStyle


public static class Notification.BigPictureStyle
extends Notification.Style

java.lang.Object
   ↳ android.app.Notification.Style
     ↳ android.app.Notification.BigPictureStyle


Helper class for generating large-format notifications that include a large image attachment. Here's how you'd set the BigPictureStyle on a notification:

 Notification notif = 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

Inherited fields

Public constructors

BigPictureStyle()
BigPictureStyle(Notification.Builder builder)

This constructor is deprecated. use BigPictureStyle().

Public methods

Notification.BigPictureStyle bigLargeIcon(Bitmap b)

Override the large icon when the big notification is shown.

Notification.BigPictureStyle bigLargeIcon(Icon icon)

Override the large icon when the big notification is shown.

Notification.BigPictureStyle bigPicture(Bitmap b)

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

Notification.BigPictureStyle bigPicture(Icon icon)

Provide the content Uri to be used as the payload for the BigPicture notification.

Notification.BigPictureStyle setBigContentTitle(CharSequence title)

Overrides ContentTitle in the big form of the template.

Notification.BigPictureStyle setContentDescription(CharSequence contentDescription)

Set the content description of the big picture.

Notification.BigPictureStyle setSummaryText(CharSequence cs)

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

Notification.BigPictureStyle showBigPictureWhenCollapsed(boolean show)

When set, the big picture of this style will be promoted and shown in place of the large icon in the collapsed state of this notification.

Inherited methods

Public constructors

BigPictureStyle

Added in API level 16
public BigPictureStyle ()

BigPictureStyle

Added in API level 16
public BigPictureStyle (Notification.Builder builder)

This constructor is deprecated.
use BigPictureStyle().

Parameters
builder Notification.Builder

Public methods

bigLargeIcon

Added in API level 16
public Notification.BigPictureStyle bigLargeIcon (Bitmap b)

Override the large icon when the big notification is shown.

Parameters
b Bitmap: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

bigLargeIcon

Added in API level 23
public Notification.BigPictureStyle bigLargeIcon (Icon icon)

Override the large icon when the big notification is shown.

Parameters
icon Icon: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

bigPicture

Added in API level 16
public Notification.BigPictureStyle bigPicture (Bitmap b)

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

Parameters
b Bitmap: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

bigPicture

Added in API level 31
public Notification.BigPictureStyle bigPicture (Icon icon)

Provide the content Uri to be used as the payload for the BigPicture notification.

Parameters
icon Icon: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

setBigContentTitle

Added in API level 16
public Notification.BigPictureStyle setBigContentTitle (CharSequence title)

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

Parameters
title CharSequence: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

setContentDescription

Added in API level 31
public Notification.BigPictureStyle setContentDescription (CharSequence contentDescription)

Set the content description of the big picture.

Parameters
contentDescription CharSequence: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

setSummaryText

Added in API level 16
public Notification.BigPictureStyle setSummaryText (CharSequence cs)

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

Parameters
cs CharSequence: This value may be null.

Returns
Notification.BigPictureStyle This value cannot be null.

showBigPictureWhenCollapsed

Added in API level 31
public Notification.BigPictureStyle showBigPictureWhenCollapsed (boolean show)

When set, the big picture of this style will be promoted and shown in place of the large icon in the collapsed state of this notification.

Parameters
show boolean

Returns
Notification.BigPictureStyle This value cannot be null.