NotificationCompat.MessagingStyle
class NotificationCompat.MessagingStyle : NotificationCompat.Style
| kotlin.Any | ||
| ↳ | androidx.core.app.NotificationCompat.Style | |
| ↳ | androidx.core.app.NotificationCompat.MessagingStyle |
Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people. In order to get a backwards compatible behavior, the app needs to use the v7 version of the notification builder together with this style, otherwise the user will see the normal notification view. Use setConversationTitle to set a conversation title for group chats with more than two people. This could be the user-created name of the group or, if it doesn't have a specific name, a list of the participants in the conversation. Do not set a conversation title for one-on-one chats, since platforms use the existence of this field as a hint that the conversation is a group. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:
Notification notification = new Notification.Builder() .setContentTitle("2 new messages with " + sender.toString()) .setContentText(subject) .setSmallIcon(R.drawable.new_message) .setLargeIcon(aBitmap) .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name)) .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender()) .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender())) .build();
Summary
Nested types |
|---|
Constants |
|
|---|---|
const Int |
The maximum number of messages that will be retained in the Notification itself (the number displayed is up to the platform). |
Public constructors |
|---|
This function is deprecated. Use |
MessagingStyle(user: Person)Creates a new |
Public functions |
|
|---|---|
Unit |
addCompatExtras(extras: Bundle)This is called with the extras of the framework |
NotificationCompat.MessagingStyle |
Adds a |
NotificationCompat.MessagingStyle |
Adds a |
NotificationCompat.MessagingStyle |
addMessage(text: CharSequence?, timestamp: Long, person: Person?)Adds a message for display by this notification. |
NotificationCompat.MessagingStyle |
This function is deprecated. Use |
java-static NotificationCompat.MessagingStyle? |
extractMessagingStyleFromNotification(notification: Notification)Retrieves a |
CharSequence? |
Return the title to be displayed on this conversation. |
(Mutable)List<NotificationCompat.MessagingStyle.Message!> |
Gets the list of historic |
(Mutable)List<NotificationCompat.MessagingStyle.Message!> |
Gets the list of |
Person |
getUser()Returns the person to be used for any replies sent by the user. |
CharSequence? |
This function is deprecated. Use |
Boolean |
Returns |
NotificationCompat.MessagingStyle |
setConversationTitle(conversationTitle: CharSequence?)Sets the title to be displayed on this conversation. |
NotificationCompat.MessagingStyle |
setGroupConversation(isGroupConversation: Boolean)Sets whether this conversation notification represents a group. |
Inherited functions |
||||
|---|---|---|---|---|
|
Constants
MAXIMUM_RETAINED_MESSAGES
const val MAXIMUM_RETAINED_MESSAGES = 25: Int
The maximum number of messages that will be retained in the Notification itself (the number displayed is up to the platform).
Public constructors
MessagingStyle(userDisplayName: CharSequence)
| Parameters | |
|---|---|
userDisplayName: CharSequence |
Required - the name to be displayed for any replies sent by the user before the posting app reposts the notification with those messages after they've been actually sent and in previous messages sent by the user added in |
MessagingStyle
MessagingStyle(user: Person)
Creates a new MessagingStyle object. Note that Person must have a non-empty name.
Public functions
addCompatExtras
fun addCompatExtras(extras: Bundle): Unit
This is called with the extras of the framework Notification during the build process, after apply() has been called. This means that you only need to add data which won't be populated by the framework Notification which was built so far. Moreover, recovering builders and styles is only supported at API 19 and above, no implementation is required for current BigTextStyle, BigPictureStyle, or InboxStyle.
addHistoricMessage
fun addHistoricMessage(message: NotificationCompat.MessagingStyle.Message?): NotificationCompat.MessagingStyle
Adds a Message for historic context in this notification.
Messages should be added as historic if they are not the main subject of the notification but may give context to a conversation. The system may choose to present them only when relevant, e.g. when replying to a message through a RemoteInput.
The messages should be added in chronologic order, i.e. the oldest first, the newest last.
| Parameters | |
|---|---|
message: NotificationCompat.MessagingStyle.Message? |
The historic |
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this object for method chaining |
addMessage
fun addMessage(message: NotificationCompat.MessagingStyle.Message?): NotificationCompat.MessagingStyle
Adds a Message for display in this notification.
| Parameters | |
|---|---|
message: NotificationCompat.MessagingStyle.Message? |
The |
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this object for method chaining |
addMessage
fun addMessage(text: CharSequence?, timestamp: Long, person: Person?): NotificationCompat.MessagingStyle
Adds a message for display by this notification. Convenience call for addMessage.
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this for method chaining |
| See also | |
|---|---|
Message |
funaddMessage(text: CharSequence?, timestamp: Long, sender: CharSequence?): NotificationCompat.MessagingStyle
Adds a message for display by this notification. Convenience call for a simple Message in addMessage
| Parameters | |
|---|---|
text: CharSequence? |
A |
timestamp: Long |
Time at which the message arrived in ms since Unix epoch |
sender: CharSequence? |
A |
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this object for method chaining |
| See also | |
|---|---|
Message |
extractMessagingStyleFromNotification
java-static fun extractMessagingStyleFromNotification(notification: Notification): NotificationCompat.MessagingStyle?
Retrieves a MessagingStyle from a Notification, enabling an application that has set a MessagingStyle using NotificationCompat or Notification.Builder to send messaging information to another application using NotificationCompat, regardless of the API level of the system.
| Returns | |
|---|---|
NotificationCompat.MessagingStyle? |
|
getConversationTitle
fun getConversationTitle(): CharSequence?
Return the title to be displayed on this conversation. Can be null.
getHistoricMessages
fun getHistoricMessages(): (Mutable)List<NotificationCompat.MessagingStyle.Message!>
Gets the list of historic Messages in the notification.
getMessages
fun getMessages(): (Mutable)List<NotificationCompat.MessagingStyle.Message!>
Gets the list of Message objects that represent the notification.
getUser
fun getUser(): Person
Returns the person to be used for any replies sent by the user.
fungetUserDisplayName(): CharSequence?
Returns the name to be displayed for any replies sent by the user.
isGroupConversation
fun isGroupConversation(): Boolean
Returns true if this notification represents a group conversation, otherwise false.
If the application that generated this MessagingStyle targets an SDK version less than P and setGroupConversation was not called, this method becomes dependent on whether or not the conversation title is set; returning true if the conversation title is a non-null value, or false otherwise. This is to maintain backwards compatibility. Regardless, setGroupConversation has precedence over this legacy behavior. From P forward, setConversationTitle has no affect on group conversation status.
| See also | |
|---|---|
setConversationTitle |
setConversationTitle
fun setConversationTitle(conversationTitle: CharSequence?): NotificationCompat.MessagingStyle
Sets the title to be displayed on this conversation. May be set to null.
This API's behavior was changed in SDK version P. If your application's target version is less than P, setting a conversation title to a non-null value will make isGroupConversation return true and passing null will make it return false. This behavior can be overridden by calling setGroupConversation regardless of SDK version. In P and above, this method does not affect group conversation settings.
| Parameters | |
|---|---|
conversationTitle: CharSequence? |
Title displayed for this conversation |
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this object for method chaining |
setGroupConversation
fun setGroupConversation(isGroupConversation: Boolean): NotificationCompat.MessagingStyle
Sets whether this conversation notification represents a group. An app should set isGroupConversation true to mark that the conversation involves multiple people.
Group conversation notifications may display additional group-related context not present in non-group notifications.
| Parameters | |
|---|---|
isGroupConversation: Boolean |
|
| Returns | |
|---|---|
NotificationCompat.MessagingStyle |
this object for method chaining |
| See also | |
|---|---|
isGroupConversation |