Skip to content

Commit 11045e1

Browse files
authored
Remove comments specifying downstream messages (#1624)
* Remove comments specifying downstream messages * Update messaging.h
1 parent d170cb6 commit 11045e1

File tree

1 file changed

+1
-29
lines changed

1 file changed

+1
-29
lines changed

messaging/src/include/firebase/messaging.h

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,7 @@ struct Notification {
192192
AndroidNotificationParams* android;
193193
};
194194

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

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

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

308298
/// Sets the priority of the message. Valid values are "normal" and "high." On
@@ -319,9 +309,6 @@ struct Message {
319309
///
320310
/// For more information, see [Setting the priority of a message][1].
321311
///
322-
/// This field is only used for downstream messages received through
323-
/// Listener::OnMessage().
324-
///
325312
/// [1]:
326313
/// https://firebase.google.com/docs/cloud-messaging/concept-options#setting-the-priority-of-a-message
327314
std::string priority;
@@ -331,24 +318,15 @@ struct Message {
331318
/// supported is 4 weeks, and the default value is 4 weeks. For more
332319
/// information, see [Setting the lifespan of a message][1].
333320
///
334-
/// This field is only used for downstream messages received through
335-
/// Listener::OnMessage().
336-
///
337321
/// [1]: https://firebase.google.com/docs/cloud-messaging/concept-options#ttl
338322
int32_t time_to_live;
339323

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

348329
/// Human readable details about the error.
349-
///
350-
/// This field is only used for downstream messages received through
351-
/// Listener::OnMessage().
352330
std::string error_description;
353331

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

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

372347
/// The link into the app from the message.
373-
///
374-
/// This field is only used for downstream messages received through
375-
/// Listener::OnMessage().
376348
std::string link;
377349

378350
/// @cond FIREBASE_APP_INTERNAL

0 commit comments

Comments
 (0)