BigTextStyle

Kotlin |Java

open class BigTextStyle : NotificationCompat.Style

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

Helper class for generating large-format notifications that include a lot of text.
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 mail from " + sender.toString())
          .setContentText(subject)
          .setSmallIcon(R.drawable.new_mail)
          .setLargeIcon(aBitmap)
          .setStyle(new Notification.BigTextStyle()
              .bigText(aVeryLongString))
          .build();

Summary

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

Public methods
open NotificationCompat.BigTextStyle	`bigText(@Nullable cs: CharSequence?)` Provide the longer text to be displayed in the big form of the template in place of the content text.
open NotificationCompat.BigTextStyle	`setBigContentTitle(@Nullable title: CharSequence?)` Overrides ContentTitle in the big form of the template.
open NotificationCompat.BigTextStyle	`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>

BigTextStyle()

<init>

BigTextStyle(@Nullable builder: NotificationCompat.Builder?)

Public methods

bigText

@NonNull open fun bigText(@Nullable cs: CharSequence?): NotificationCompat.BigTextStyle

Provide the longer text to be displayed in the big form of the template in place of the content text.

setBigContentTitle

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

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

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