NotificationCompat.BigTextStyle

Added in 1.1.0

Kotlin |Java

class NotificationCompat.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();

See also
`bigContentView`

Summary

Public constructors
`BigTextStyle()`
`BigTextStyle(builder: NotificationCompat.Builder?)`

Public functions
`NotificationCompat.BigTextStyle`	`bigText(cs: CharSequence?)` Provide the longer text to be displayed in the big form of the template in place of the content text.
`NotificationCompat.BigTextStyle`	`setBigContentTitle(title: CharSequence?)` Overrides ContentTitle in the big form of the template.
`NotificationCompat.BigTextStyle`	`setSummaryText(cs: CharSequence?)` Set the first line of text after the detail section in the big form of the template.

Inherited functions

From androidx.core.app.NotificationCompat.Style

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

Public constructors

BigTextStyle

Added in 1.1.0

BigTextStyle()

BigTextStyle

Added in 1.1.0

BigTextStyle(builder: NotificationCompat.Builder?)

Public functions

bigText

Added in 1.1.0

fun bigText(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

Added in 1.1.0

fun setBigContentTitle(title: CharSequence?): NotificationCompat.BigTextStyle

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

setSummaryText

Added in 1.1.0

fun setSummaryText(cs: CharSequence?): NotificationCompat.BigTextStyle

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