NotificationCompat.BigPictureStyle
public
static
class
NotificationCompat.BigPictureStyle
extends NotificationCompat.Style
java.lang.Object | ||
↳ | 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();
See also:
Summary
Public constructors | |
---|---|
BigPictureStyle()
|
|
BigPictureStyle(NotificationCompat.Builder builder)
|
Public methods | |
---|---|
NotificationCompat.BigPictureStyle
|
bigLargeIcon(Bitmap b)
Override the large icon when the big notification is shown. |
NotificationCompat.BigPictureStyle
|
bigPicture(Bitmap b)
Provide the bitmap to be used as the payload for the BigPicture notification. |
NotificationCompat.BigPictureStyle
|
setBigContentTitle(CharSequence title)
Overrides ContentTitle in the big form of the template. |
NotificationCompat.BigPictureStyle
|
setSummaryText(CharSequence cs)
Set the first line of text after the detail section in the big form of the template. |
Inherited methods | |
---|---|
Public constructors
BigPictureStyle
public BigPictureStyle ()
BigPictureStyle
public BigPictureStyle (NotificationCompat.Builder builder)
Parameters | |
---|---|
builder |
NotificationCompat.Builder |
Public methods
bigLargeIcon
public NotificationCompat.BigPictureStyle bigLargeIcon (Bitmap b)
Override the large icon when the big notification is shown.
Parameters | |
---|---|
b |
Bitmap |
Returns | |
---|---|
NotificationCompat.BigPictureStyle |
bigPicture
public NotificationCompat.BigPictureStyle bigPicture (Bitmap b)
Provide the bitmap to be used as the payload for the BigPicture notification.
Parameters | |
---|---|
b |
Bitmap |
Returns | |
---|---|
NotificationCompat.BigPictureStyle |
setBigContentTitle
public NotificationCompat.BigPictureStyle setBigContentTitle (CharSequence title)
Overrides ContentTitle in the big form of the template. This defaults to the value passed to setContentTitle().
Parameters | |
---|---|
title |
CharSequence |
Returns | |
---|---|
NotificationCompat.BigPictureStyle |
setSummaryText
public NotificationCompat.BigPictureStyle setSummaryText (CharSequence cs)
Set the first line of text after the detail section in the big form of the template.
Parameters | |
---|---|
cs |
CharSequence |
Returns | |
---|---|
NotificationCompat.BigPictureStyle |