# NotificationCompat.InboxStyle

# NotificationCompat.InboxStyle

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core)  
[View Source](https://cs.android.com/search?q=file:androidx/core/app/NotificationCompat.java+class:androidx.core.app.NotificationCompat.InboxStyle)  
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/androidx/core/app/NotificationCompat.InboxStyle "View this page in Java")


```
class NotificationCompat.InboxStyle : NotificationCompat.Style
```

<br />

|---|---|---------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)                                                                      |||
| ↳ | [androidx.core.app.NotificationCompat.Style](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Style)              ||
|   | ↳ | [androidx.core.app.NotificationCompat.InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle) |

*** ** * ** ***

Helper class for generating large-format notifications that include a list of (up to 5) strings. 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:  

```kotlin
Notification notification = new Notification.Builder()
    .setContentTitle("5 New mails from " + sender.toString())
    .setContentText(subject)
    .setSmallIcon(R.drawable.new_mail)
    .setLargeIcon(aBitmap)
    .setStyle(new Notification.InboxStyle()
        .addLine(str1)
        .addLine(str2)
        .setContentTitle("")
        .setSummaryText("+3 more"))
    .build();
```  

|                                                 See also                                                 |
|----------------------------------------------------------------------------------------------------------|---|
| [bigContentView](https://developer.android.com/reference/android/app/Notification.html#bigContentView()) |   |

## Summary

|                                                                                                                                            ### Public constructors                                                                                                                                             |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle#InboxStyle())`()`                                                                                                                                                                                  |
| [InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle#InboxStyle(androidx.core.app.NotificationCompat.Builder))`(builder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder)`?)` |

|                                                      ### Public functions                                                       |
|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [NotificationCompat.InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle) | [addLine](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle#addLine(java.lang.CharSequence))`(cs: `[CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)`?)` Append a line to the digest section of the Inbox notification.                                     |
| [NotificationCompat.InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle) | [setBigContentTitle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle#setBigContentTitle(java.lang.CharSequence))`(title: `[CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)`?)` Overrides ContentTitle in the big form of the template.                   |
| [NotificationCompat.InboxStyle](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle) | [setSummaryText](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.InboxStyle#setSummaryText(java.lang.CharSequence))`(cs: `[CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)`?)` 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](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Style) |------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Notification](https://developer.android.com/reference/android/app/Notification.html)`?` | [build](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Style#build())`()` If this Style object has been set on a notification builder, this method will build that notification and return it.                                                                                                                                      | | [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)            | [setBuilder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Style#setBuilder(androidx.core.app.NotificationCompat.Builder))`(builder: `[NotificationCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat.Builder)`?)` Link this rich notification style with a notification builder. | |

## Public constructors

### InboxStyle

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
InboxStyle()
```  

### InboxStyle

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
InboxStyle(builder: NotificationCompat.Builder?)
```  

## Public functions

### addLine

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
fun addLine(cs: CharSequence?): NotificationCompat.InboxStyle
```

Append a line to the digest section of the Inbox notification.  

### setBigContentTitle

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
fun setBigContentTitle(title: CharSequence?): NotificationCompat.InboxStyle
```

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

### setSummaryText

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)  

```
fun setSummaryText(cs: CharSequence?): NotificationCompat.InboxStyle
```

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