Widen Data Pipes and newer protobufs

sync/protocol/synced_notification_render.proto

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 
 // Update proto_value_conversions{.h,.cc,_unittest.cc} if you change
 // any fields in this file.
 
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 option retain_unknown_fields = true;
 
 package sync_pb;
 
 // Data that is used directly by endpoints to render notifications in the case
 // where no "native" app can handle the notification.
 message SyncedNotificationRenderInfo {
-
-  // Render information for the collapsed (summary) view of a coalesced
-  // notification.
-  message CollapsedInfo {
-    message SimpleCollapsedLayout {
-      // Application icon.
-      optional SyncedNotificationImage app_icon = 1;
-
-      // Profile image(s) of the notification creator(s) to show in the
-      // collapsed UI.
-      repeated SyncedNotificationProfileImage profile_image = 2;
-
-      // Heading - often the name(s) of the notification creator(s).
-      optional string heading = 3;
-
-      // Description - often the action that generated the notification.
-      optional string description = 4;
-    }
-    optional SimpleCollapsedLayout simple_collapsed_layout = 1;
-
-    // The creation time of the notification in microseconds since the UNIX
-    // epoch.
-    optional uint64 creation_timestamp_usec = 2;
-
-    // The default destination target.
-    optional SyncedNotificationDestination default_destination = 3;
-
-    // Secondary destinations and actions grouped into a message to account for
-    // ordering.
-    message Target {
-      optional SyncedNotificationDestination destination = 1;
-      optional SyncedNotificationAction action = 2;
-    }
-    repeated Target target = 4;
-  }
   optional CollapsedInfo collapsed_info = 1;

[Nicolas Zea, 2013/03/28 17:43:41]

Comment about what these fields are

[Pete Williamson, 2013/03/28 19:59:00]

Done.

 
-  // Render information for the expanded (detail) view of a coalesced
-  // notification.
-  message ExpandedInfo {
-    message SimpleExpandedLayout {
-      // Title - often the title of the underlying entity referred to by the
-      // notification(s).
-      optional string title = 1;
+  optional ExpandedInfo expanded_info = 2;
+}
 
-      // Text content - often a snippet of text from the underlying entity
-      // reference or the notification.
-      optional string text = 2;
+// Render information for the collapsed (summary) view of a coalesced
+// notification.
+message CollapsedInfo {

[Nicolas Zea, 2013/03/28 17:43:41]

nit: could you define this (and Expanded info) above where they are used?

Also, comment about simple_collapsed_layout

[Pete Williamson, 2013/03/28 19:59:00]

As we discussed over chat, I re-ordered the file so that they are all used
before their definition - this means that we have higher level objects above
lower level objects.

+  optional SimpleCollapsedLayout simple_collapsed_layout = 1;
 
-      // Media.
-      message Media {
-        // TOOD(jro): Do we need other media types?
-        optional SyncedNotificationImage image = 1;
-      }
-      repeated Media media = 3;
-    }
-    optional SimpleExpandedLayout simple_expanded_layout = 1;
+  // The creation time of the notification in microseconds since the UNIX
+  // epoch.
+  optional uint64 creation_timestamp_usec = 2;
 
-    // Collapsed information for each notification in the coalesced group.
-    repeated CollapsedInfo collapsed_info = 2;
-   }
-  optional ExpandedInfo expanded_info = 2;
+  // The default destination target.
+  optional SyncedNotificationDestination default_destination = 3;
+
+  repeated Target target = 4;
+}
+
+message SimpleCollapsedLayout {
+  // Application icon.
+  optional SyncedNotificationImage app_icon = 1;
+
+  // Profile image(s) of the notification creator(s) to show in the
+  // collapsed UI.
+  repeated SyncedNotificationProfileImage profile_image = 2;
+
+  // Heading - often the name(s) of the notification creator(s).
+  optional string heading = 3;
+
+  // Description - often the action that generated the notification.
+  optional string description = 4;
+}
+
+message SimpleExpandedLayout {
+  // Title - often the title of the underlying entity referred to by the
+  // notification(s).
+  optional string title = 1;
+
+  // Text content - often a snippet of text from the underlying entity
+  // reference or the notification.
+  optional string text = 2;
+
+  repeated Media media = 3;
+
+  // Profile image, usually this is the creator of the referenced entity.
+  optional SyncedNotificationProfileImage profile_image = 4;
+
+  // A set of targets for actions the user can take, or destinations the
+  // viewer can be taken to. Usually these relate to the referenced entity.
+  repeated Target target = 5;
+}
+
+// Media.
+message Media {
+  // TOOD(jro): Do we need other media types?
+  optional SyncedNotificationImage image = 1;
+}
+
+// Render information for the expanded (detail) view of a coalesced
+// notification.
+message ExpandedInfo {
+  optional SimpleExpandedLayout simple_expanded_layout = 1;
+
+  // Collapsed information for each notification in the coalesced group.
+  repeated CollapsedInfo collapsed_info = 2;
 }
 
 // A Destination is a target URL that the user can be taken to by clicking on or
 // selecting the notification or part thereof.
 message SyncedNotificationDestination {
   // The description for the link to the destination.
   optional string text = 1;
 
   // The icon to use for the link to the destination.
   optional SyncedNotificationImage icon = 2;
 
   // The destination URL.
   optional string url = 3;
 
   // Optional label to aid accessibility.
   optional string accessibility_label = 4;
 }
 
 // An Action encapsulates an UI component that trigger certain programmable
 // actions.  Depending on the endpoint, this may show up as a HTML button, an
 // action button associated with the notification on native mobile, a link, or
 // even the notification card itself.
 message SyncedNotificationAction {
-   // The description for the Action.
-   optional string text = 1;
+  // The description for the Action.
+  optional string text = 1;
 
   // The icon to use for the Action.
   optional SyncedNotificationImage icon = 2;
 
   // The URL that performs the action.
   optional string url = 3;
 
   // Additional request data.
   optional string request_data = 4;
 
@@ skipping 10 matching lines @@
   optional int32 preferred_height = 4;
 }
 
 message SyncedNotificationProfileImage {
   // Url for the image.
   optional string image_url = 1;
   // Object id for the image.
   optional string oid = 2;
   // Name to display for this image.
   optional string display_name = 3;
-}
+}
+
+// Secondary destinations and actions grouped into a message to account for
+// ordering.
+message Target {
+  optional SyncedNotificationDestination destination = 1;

[Nicolas Zea, 2013/03/28 17:43:41]

Comments about fields

[Pete Williamson, 2013/03/28 19:59:00]

Done.

+  optional SyncedNotificationAction action = 2;
+
+  // A key to identify this target within a group of targets.
+  optional string target_key = 3;
+}