added in version 1.0.0
belongs to Maven artifact androidx.core:core:1.0.0-beta01

NotificationCompat.MessagingStyle.Message

public static final class NotificationCompat.MessagingStyle.Message
extends Object

java.lang.Object
   ↳ androidx.core.app.NotificationCompat.MessagingStyle.Message


Summary

Public constructors

NotificationCompat.MessagingStyle.Message(CharSequence text, long timestamp, Person person)

Creates a new NotificationCompat.MessagingStyle.Message with the given text, timestamp, and sender.

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

This constructor was deprecated in API level 1.0.0. Use the alternative constructor instead.

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.

Person getPerson()

Returns the Person sender of this message.

CharSequence getSender()

This method was deprecated in API level 1.0.0. Use getPerson()

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 in ms since Unix epoch.

NotificationCompat.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

NotificationCompat.MessagingStyle.Message

added in version 1.0.0
public NotificationCompat.MessagingStyle.Message (CharSequence text, 
                long timestamp, 
                Person person)

Creates a new NotificationCompat.MessagingStyle.Message with the given text, timestamp, and sender.

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

timestamp long: Time at which the message arrived in ms since Unix epoch

person Person: A Person whose Person.getName() value is used as the display name for the sender. This should be null for messages by the current user, in which case, the platform will insert NotificationCompat.MessagingStyle.getUserDisplayName(). A Person's key should be consistent during re-posts of the notification.

NotificationCompat.MessagingStyle.Message

added in version 1.0.0
public NotificationCompat.MessagingStyle.Message (CharSequence text, 
                long timestamp, 
                CharSequence sender)

This constructor was deprecated in API level 1.0.0.
Use the alternative constructor instead.

Constructor

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

timestamp long: Time at which the message arrived in ms since Unix epoch

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

Public methods

getDataMimeType

added in version 1.0.0
public String getDataMimeType ()

Get the MIME type of the data pointed to by the URI.

Returns
String

getDataUri

added in version 1.0.0
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 version 1.0.0
public Bundle getExtras ()

Get the extras Bundle for this message.

Returns
Bundle

getPerson

added in version 1.0.0
public Person getPerson ()

Returns the Person sender of this message.

Returns
Person

getSender

added in version 1.0.0
public CharSequence getSender ()

This method was deprecated in API level 1.0.0.
Use getPerson()

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

Returns
CharSequence

getText

added in version 1.0.0
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 version 1.0.0
public long getTimestamp ()

Get the time at which this message arrived in ms since Unix epoch.

Returns
long

setData

added in version 1.0.0
public NotificationCompat.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
NotificationCompat.MessagingStyle.Message this object for method chaining