NotificationCompat.BigTextStyle

Added in 1.1.0

Kotlin |Java

public class NotificationCompat.BigTextStyle extends NotificationCompat.Style

java.lang.Object
↳	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(@Nullable NotificationCompat.Builder builder)`

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

Inherited methods

From androidx.core.app.NotificationCompat.Style

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

Public constructors

BigTextStyle

Added in 1.1.0

public BigTextStyle()

BigTextStyle

Added in 1.1.0

public BigTextStyle(@Nullable NotificationCompat.Builder builder)

Public methods

bigText

Added in 1.1.0

public @NonNull NotificationCompat.BigTextStyle bigText(@Nullable CharSequence cs)

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

public @NonNull NotificationCompat.BigTextStyle setBigContentTitle(@Nullable CharSequence title)

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

setSummaryText

Added in 1.1.0

public @NonNull NotificationCompat.BigTextStyle setSummaryText(@Nullable CharSequence cs)

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