Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

Notification.MessagingStyle.Message

public static final class Notification.MessagingStyle.Message
extends Object

java.lang.Object
   ↳ android.app.Notification.MessagingStyle.Message


Summary

Public constructors

Notification.MessagingStyle.Message(CharSequence text, long timestamp, CharSequence sender)

This constructor was deprecated in API level 28. use Message(CharSequence, long, Person)

Notification.MessagingStyle.Message(CharSequence text, long timestamp, Person sender)

Constructor

Public methods

String getDataMimeType()

Get the MIME type of the data pointed to by the Uri

Uri getDataUri()

Get the the Uri pointing to the content of the message.

Bundle getExtras()

Get the extras Bundle for this message.

CharSequence getSender()

This method was deprecated in API level 28. use getSenderPerson()

Person getSenderPerson()

Get the sender associated with this message.

CharSequence getText()

Get the text to be used for this message, or the fallback text if a type and content Uri have been set

long getTimestamp()

Get the time at which this message arrived

Notification.MessagingStyle.Message setData(String dataMimeType, Uri dataUri)

Sets a binary blob of data and an associated MIME type for a message.

Inherited methods

Public constructors

Notification.MessagingStyle.Message

added in API level 24
public Notification.MessagingStyle.Message (CharSequence text, 
                long timestamp, 
                CharSequence sender)

This constructor was deprecated in API level 28.
use Message(CharSequence, long, Person)

Constructor

Parameters
text CharSequence: A CharSequence to be displayed as the message content

timestamp long: Time at which the message arrived

sender CharSequence: A 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 Notification.MessagingStyle.getUserDisplayName(). Should be unique amongst all individuals in the conversation, and should be consistent during re-posts of the notification.

Notification.MessagingStyle.Message

added in API level 28
public Notification.MessagingStyle.Message (CharSequence text, 
                long timestamp, 
                Person sender)

Constructor

Parameters
text CharSequence: A CharSequence to be displayed as the message content

This value must never be null.

timestamp long: Time at which the message arrived

sender Person: The Person who sent the message. Should be null for messages by the current user, in which case the platform will insert the user set in MessagingStyle(Person).

The person provided should contain an Icon, set with Person.Builder.setIcon(Icon) and also have a name provided with Person.Builder.setName(CharSequence). If multiple users have the same name, consider providing a key with Person.Builder.setKey(String) in order to differentiate between the different users.

Public methods

getDataMimeType

added in API level 24
public String getDataMimeType ()

Get the MIME type of the data pointed to by the Uri

Returns
String

getDataUri

added in API level 24
public Uri getDataUri ()

Get the the Uri pointing to the content of the message. Can be null, in which case is used.

Returns
Uri

See also:

getExtras

added in API level 26
public Bundle getExtras ()

Get the extras Bundle for this message.

Returns
Bundle

getSender

added in API level 24
public CharSequence getSender ()

This method was deprecated in API level 28.
use getSenderPerson()

Get the text used to display the contact's name in the messaging experience

Returns
CharSequence

getSenderPerson

added in API level 28
public Person getSenderPerson ()

Get the sender associated with this message.

Returns
Person

This value may be null.

getText

added in API level 24
public CharSequence getText ()

Get the text to be used for this message, or the fallback text if a type and content Uri have been set

Returns
CharSequence

getTimestamp

added in API level 24
public long getTimestamp ()

Get the time at which this message arrived

Returns
long

setData

added in API level 24
public Notification.MessagingStyle.Message setData (String dataMimeType, 
                Uri dataUri)

Sets a binary blob of data and an associated MIME type for a message. In the case where the platform doesn't support the MIME type, the original text provided in the constructor will be used.

Parameters
dataMimeType String: The MIME type of the content. See for the list of supported MIME types on Android and Android Wear.

dataUri Uri: The uri containing the content whose type is given by the MIME type.

  1. Notification Listeners including the System UI need permission to access the data the Uri points to. The recommended ways to do this are:
  2. Store the data in your own ContentProvider, making sure that other apps have the correct permission to access your provider. The preferred mechanism for providing access is to use per-URI permissions which are temporary and only grant access to the receiving application. An easy way to create a ContentProvider like this is to use the FileProvider helper class.
  3. Use the system MediaStore. The MediaStore is primarily aimed at video, audio and image MIME types, however beginning with Android 3.0 (API level 11) it can also store non-media types (see MediaStore.Files for more info). Files can be inserted into the MediaStore using scanFile() after which a content:// style Uri suitable for sharing is passed to the provided onScanCompleted() callback. Note that once added to the system MediaStore the content is accessible to any app on the device.

Returns
Notification.MessagingStyle.Message this object for method chaining