public final class

RemoteMessage

extends Object
implements Parcelable
java.lang.Object
   ↳ com.google.firebase.messaging.RemoteMessage

Class Overview

A remote Firebase Message. Messages will be received via onMessageReceived(RemoteMessage) and can be sent via send(RemoteMessage). Messages may have a RemoteMessage.Notification instance if they are received while the application is in the foreground, otherwise they will be automatically posted to the notification tray. Use the RemoteMessage.Builder class for building message instances to send via send(RemoteMessage).

Summary

Nested Classes
class RemoteMessage.Builder Builder object for constructing RemoteMessage instances. 
class RemoteMessage.Notification Remote Firebase notification details. 
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Methods
String getCollapseKey()
Get the collapse key of the message.
Map<String, String> getData()
The message payload data.
String getFrom()
Get the sender of this message.
String getMessageId()
Get the message's ID.
String getMessageType()
Get the type of message.
RemoteMessage.Notification getNotification()
Get the message notification if any.
long getSentTime()
Get the time in milliseconds from the Epoch that the message was sent.
String getTo()
Get the message destination.
int getTtl()
Get the message time to live (TTL) in seconds.
void writeToParcel(Parcel out, int flags)
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Public Methods

public String getCollapseKey ()

Get the collapse key of the message.

Returns
String The collapse key

public Map<String, String> getData ()

The message payload data.

Returns
Map<String, String> A map of the message payload.

public String getFrom ()

Get the sender of this message. This will be the sender ID or the topic for topic messages.

Returns
String The message sender

public String getMessageId ()

Get the message's ID. This will be the message ID set when sending the message or automatically generated by the server.

Returns
String The message ID

public String getMessageType ()

Get the type of message.

Returns
String The message type

public RemoteMessage.Notification getNotification ()

Get the message notification if any. This field will be non-null if a notification message is received while the application is in the foreground.

Returns
RemoteMessage.Notification The message notification or null.

public long getSentTime ()

Get the time in milliseconds from the Epoch that the message was sent.

Returns
long The time that the message was sent

public String getTo ()

Get the message destination. For upstream messages this will be of the form SENDER_ID&#64;gcm.googleapis.com.

Returns
String The message destination

public int getTtl ()

Get the message time to live (TTL) in seconds.

Returns
int The message TTL

public void writeToParcel (Parcel out, int flags)

Parameters
out Parcel
flags int