Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove comments specifying downstream messages #1624

Merged
merged 2 commits into from
Jul 10, 2024
Merged

Remove comments specifying downstream messages #1624

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
783bdd3
Remove comments specifying downstream messages
a-maurice Jul 9, 2024
105c940
Update messaging.h
a-maurice Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 1 addition & 29 deletions messaging/src/include/firebase/messaging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,7 @@ struct Notification {
AndroidNotificationParams* android;
};

/// @brief Data structure used to send messages to, and receive messages from,
/// cloud messaging.
/// @brief Data structure used to receive messages from cloud messaging.
struct Message {
/// Initialize the message.
Message()
Expand Down Expand Up @@ -241,9 +240,6 @@ struct Message {
/// Authenticated ID of the sender. This is a project number in most cases.
///
/// Any value starting with google.com, goog. or gcm. are reserved.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string from;

/// This parameter specifies the recipient of a message.
Expand All @@ -266,9 +262,6 @@ struct Message {
/// This means a FCM connection server can simultaneously store 4 different
/// send-to-sync messages per client app. If you exceed this number, there is
/// no guarantee which 4 collapse keys the FCM connection server will keep.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string collapse_key;

/// The metadata, including all original key/value pairs. Includes some of the
Expand Down Expand Up @@ -300,9 +293,6 @@ struct Message {
/// Parameters: "message_id" and "error"
///
/// If this field is missing, the message is a regular message.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string message_type;

/// Sets the priority of the message. Valid values are "normal" and "high." On
Expand All @@ -319,9 +309,6 @@ struct Message {
///
/// For more information, see [Setting the priority of a message][1].
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
///
/// [1]:
/// https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message
std::string priority;
Expand All @@ -331,24 +318,15 @@ struct Message {
/// supported is 4 weeks, and the default value is 4 weeks. For more
/// information, see [Setting the lifespan of a message][1].
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
///
/// [1]: https://firebase.google.com/docs/cloud-messaging/concept-options#ttl
int32_t time_to_live;

/// Error code. Used in "nack" messages for CCS, and in responses from the
/// server.
/// See the CCS specification for the externally-supported list.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string error;

/// Human readable details about the error.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string error_description;

/// Optional notification to show. This only set if a notification was
Expand All @@ -359,9 +337,6 @@ struct Message {
/// to make a copy of either the Message or Notification. Copying the Message
/// object implicitly makes a deep copy of the notification (allocated with
/// new) which is owned by the Message.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
Notification* notification;

/// A flag indicating whether this message was opened by tapping a
Expand All @@ -370,9 +345,6 @@ struct Message {
bool notification_opened;

/// The link into the app from the message.
///
/// This field is only used for downstream messages received through
/// Listener::OnMessage().
std::string link;

/// @cond FIREBASE_APP_INTERNAL
Expand Down
Loading