Synced Notification Sync Change Processor

sync/protocol/server_data.proto

+// Copyright (c) 2012 The Chromium Authors. All rights reserved.

[dcheng, 2013/01/18 21:56:13]

Meta comment that the file could use a better name. "server_data" and
"server_render" aren't very descriptive.

[Pete Williamson, 2013/01/23 01:45:55]

The file is named to match its server side counterpart.  I can rename it if you
feel this is important, but that makes porting changes when they happen just a
bit harder. 

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// Sync protocol datatype extension for push notifications..
+
+// 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;
+
+import "server_render.proto";
+
+// This message allows clients to identify a notification they have created.
+// IMPORTANT: Everything in this message may be sent to the client in clear text
+// - do not expose any user ids, internal product names, credit card numbers,
+// etc... anywhere in the message.
+message SyncedNotificationIdentifier {
+  // The application that the notification is a part of.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string app_id = 1;
+
+  // Notifications with the same coalescing key (isolated to the same app_id)
+  // will be grouped together when fetched.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string coalescing_key = 2;
+}
+
+message SyncedNotificationNotification {

[Nicolas Zea, 2013/01/18 23:09:25]

nit: perhaps just SyncedNotification and CoalescedSyncedNotification
(notificationnotification seems odd)

[Pete Williamson, 2013/01/23 01:45:55]

We already have a SyncedNotification class (it is the wrapper to provide good
C++ semantics for accessing the protobuf.)  So, I can only rename this to
SyncedNotification if I rename that.

[Nicolas Zea, 2013/01/25 00:18:45]

They're within different namespaces, so the names won't conflict.

[Pete Williamson, 2013/01/25 19:58:36]

Done.

+  // The unique identifier to identify the notification.
+  optional SyncedNotificationIdentifier id = 1;
+
+  // A secondary type that is isolated within the same app_id.
+  //
+  // NOTE: For ASBE support purposes this must be in the format [A-Za-z_]+.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string type = 2;
+
+  // Whatever string the client entered during creation.  If no external_id is
+  // specified, the notification can no longer be identified individually for
+  // fetching/deleting, etc...
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string external_id = 3;
+}
+
+message SyncedNotificationCoalescedNotification {
+  // The identifier used to identify individual coalesced notifications.
+  optional SyncedNotificationIdentifier id = 1;
+
+  // All the notifications that are grouped together.
+  repeated SyncedNotificationNotification notification = 2;
+
+  // Data that is used directly by endpoints to render notifications in the case
+  // where no "native" app can handle the notification.
+  optional SyncedNotificationRenderInfo render_info = 3;
+
+  // Read state will be per coalesced notification.
+  enum ReadState {
+    UNREAD = 1;
+    READ = 2;
+    DISMISSED = 3;
+  }
+  optional ReadState read_state = 4;
+
+  // The time when the LATEST notification of the coalesced notification is
+  // created (in Java time milliseconds).
+  optional uint64 creation_time_msec = 5;
+}