Overview

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 NotificationCompat.MessagingStyle.setConversationTitle(CharSequence) 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

Fields

The maximum number of messages that will be retained in the Notification itself (the number displayed is up to the platform).

Constructors

Deprecated: Use #MessagingStyle(Person) instead.

Parameters:

userDisplayName: 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 NotificationCompat.MessagingStyle.addMessage(NotificationCompat.MessagingStyle.Message)

Creates a new NotificationCompat.MessagingStyle object. Note that Person must have a non-empty name.

Parameters:

user: This Person's name will be shown when this app's notification is being replied to. It's used temporarily so the app has time to process the send request and repost the notification with updates to the conversation.

Methods

Deprecated: Use NotificationCompat.MessagingStyle.getUser() instead.

Returns the name to be displayed for any replies sent by the user.

Returns the person to be used for any replies sent by the user.

Sets the title to be displayed on this conversation. May be set to null.

This API's behavior was changed in SDK version . If your application's target version is less than , setting a conversation title to a non-null value will make NotificationCompat.MessagingStyle.isGroupConversation() return true and passing null will make it return false. This behavior can be overridden by calling NotificationCompat.MessagingStyle.setGroupConversation(boolean) regardless of SDK version. In and above, this method does not affect group conversation settings.

Parameters:

conversationTitle: Title displayed for this conversation

Returns:

this object for method chaining

Return the title to be displayed on this conversation. Can be null.

Deprecated: Use NotificationCompat.MessagingStyle.addMessage(CharSequence, long, Person) or NotificationCompat.MessagingStyle.addMessage(NotificationCompat.MessagingStyle.Message)

Adds a message for display by this notification. Convenience call for a simple NotificationCompat.MessagingStyle.Message in NotificationCompat.MessagingStyle.addMessage(NotificationCompat.MessagingStyle.Message)

Parameters:

text: A java.lang.CharSequence to be displayed as the message content
timestamp: Time at which the message arrived in ms since Unix epoch
sender: A java.lang.CharSequence to be used for displaying the name of the sender. Should be null for messages by the current user, in which case the platform will insert NotificationCompat.MessagingStyle.getUserDisplayName(). Should be unique amongst all individuals in the conversation, and should be consistent during re-posts of the notification.

Returns:

this object for method chaining

See also: NotificationCompat.MessagingStyle.Message

Adds a message for display by this notification. Convenience call for NotificationCompat.MessagingStyle.addMessage(NotificationCompat.MessagingStyle.Message).

Returns:

this for method chaining

See also: NotificationCompat.MessagingStyle.Message

Adds a NotificationCompat.MessagingStyle.Message for display in this notification.

Parameters:

message: The NotificationCompat.MessagingStyle.Message to be displayed

Returns:

this object for method chaining

Adds a NotificationCompat.MessagingStyle.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: The historic NotificationCompat.MessagingStyle.Message to be added

Returns:

this object for method chaining

Gets the list of Message objects that represent the notification.

Gets the list of historic Messages in the notification.

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: true if the conversation represents a group, false otherwise.

Returns:

this object for method chaining

See also: NotificationCompat.MessagingStyle.isGroupConversation()

Returns true if this notification represents a group conversation, otherwise false.

If the application that generated this NotificationCompat.MessagingStyle targets an SDK version less than and NotificationCompat.MessagingStyle.setGroupConversation(boolean) 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, NotificationCompat.MessagingStyle.setGroupConversation(boolean) has precedence over this legacy behavior. From forward, NotificationCompat.MessagingStyle.setConversationTitle(CharSequence) has no affect on group conversation status.

See also: NotificationCompat.MessagingStyle.setConversationTitle(CharSequence)

Retrieves a NotificationCompat.MessagingStyle from a Notification, enabling an application that has set a NotificationCompat.MessagingStyle using NotificationCompat or to send messaging information to another application using NotificationCompat, regardless of the API level of the system.

Returns:

null if there is no NotificationCompat.MessagingStyle set, or if the SDK version is < 16 (JellyBean).

This is called with the extras of the framework Notification during the NotificationCompat.Builder.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.