playlist4service.proto 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. import "playlist4changes.proto";
  2. import "playlist4content.proto";
  3. message RequestContext {
  4. optional bool administrative = 2;
  5. optional bool migration = 4;
  6. optional string tag = 7;
  7. optional bool useStarredView = 8;
  8. optional bool syncWithPublished = 9;
  9. }
  10. message GetCurrentRevisionArgs {
  11. optional bytes uri = 1;
  12. optional RequestContext context = 2;
  13. }
  14. message GetChangesInSequenceRangeArgs {
  15. optional bytes uri = 1;
  16. optional RequestContext context = 2;
  17. optional int32 fromSequenceNumber = 3;
  18. optional int32 toSequenceNumber = 4;
  19. }
  20. message GetChangesInSequenceRangeMatchingPl3VersionArgs {
  21. optional bytes uri = 1;
  22. optional RequestContext context = 2;
  23. optional int32 fromSequenceNumber = 3;
  24. optional int32 toSequenceNumber = 4;
  25. optional string pl3Version = 5;
  26. }
  27. message GetChangesInSequenceRangeReturn {
  28. repeated RevisionTaggedChangeSet result = 1;
  29. }
  30. message ObliterateListArgs {
  31. optional bytes uri = 1;
  32. optional RequestContext context = 2;
  33. }
  34. message UpdatePublishedArgs {
  35. optional bytes publishedUri = 1;
  36. optional RequestContext context = 2;
  37. optional bytes uri = 3;
  38. optional bool isPublished = 4;
  39. }
  40. message SynchronizeArgs {
  41. optional bytes uri = 1;
  42. optional RequestContext context = 2;
  43. optional ListContentSelection selection = 3;
  44. optional ListChanges changes = 4;
  45. }
  46. message GetSnapshotAtRevisionArgs {
  47. optional bytes uri = 1;
  48. optional RequestContext context = 2;
  49. optional bytes revision = 3;
  50. }
  51. message SubscribeRequest {
  52. repeated bytes uris = 1;
  53. }
  54. message UnsubscribeRequest {
  55. repeated bytes uris = 1;
  56. }
  57. enum Playlist4InboxErrorKind {
  58. INBOX_NOT_ALLOWED = 2;
  59. INBOX_INVALID_USER = 3;
  60. INBOX_INVALID_URI = 4;
  61. INBOX_LIST_TOO_LONG = 5;
  62. }
  63. message Playlist4ServiceException {
  64. optional string why = 1;
  65. optional string symbol = 2;
  66. optional bool permanent = 3;
  67. optional string serviceErrorClass = 4;
  68. optional Playlist4InboxErrorKind inboxErrorKind = 5;
  69. }
  70. message SynchronizeReturn {
  71. optional SelectedListContent result = 1;
  72. optional Playlist4ServiceException exception = 4;
  73. }
  74. enum Playlist4ServiceMethodKind {
  75. METHOD_UNKNOWN = 0;
  76. METHOD_GET_CURRENT_REVISION = 2;
  77. METHOD_GET_CHANGES_IN_SEQUENCE_RANGE = 3;
  78. METHOD_OBLITERATE_LIST = 4;
  79. METHOD_SYNCHRONIZE = 5;
  80. METHOD_UPDATE_PUBLISHED = 6;
  81. METHOD_GET_CHANGES_IN_SEQUENCE_RANGE_MATCHING_PL3_VERSION = 7;
  82. METHOD_GET_SNAPSHOT_AT_REVISION = 8;
  83. }
  84. message Playlist4ServiceCall {
  85. optional Playlist4ServiceMethodKind kind = 1;
  86. optional GetCurrentRevisionArgs getCurrentRevisionArgs = 2;
  87. optional GetChangesInSequenceRangeArgs getChangesInSequenceRangeArgs = 3;
  88. optional ObliterateListArgs obliterateListArgs = 4;
  89. optional SynchronizeArgs synchronizeArgs = 5;
  90. optional UpdatePublishedArgs updatePublishedArgs = 6;
  91. optional GetChangesInSequenceRangeMatchingPl3VersionArgs getChangesInSequenceRangeMatchingPl3VersionArgs = 7;
  92. optional GetSnapshotAtRevisionArgs getSnapshotAtRevisionArgs = 8;
  93. }
  94. message Playlist4ServiceReturn {
  95. optional Playlist4ServiceMethodKind kind = 1;
  96. optional Playlist4ServiceException exception = 2;
  97. optional bytes getCurrentRevisionReturn = 3;
  98. optional GetChangesInSequenceRangeReturn getChangesInSequenceRangeReturn = 4;
  99. optional bool obliterateListReturn = 5;
  100. optional SynchronizeReturn synchronizeReturn = 6;
  101. optional bool updatePublishedReturn = 7;
  102. optional GetChangesInSequenceRangeReturn getChangesInSequenceRangeMatchingPl3VersionReturn = 8;
  103. //optional RevisionTaggedListSnapshot getSnapshotAtRevisionReturn = 9;
  104. optional bytes getSnapshotAtRevisionReturn = 9;
  105. }
  106. message CreateListReply {
  107. required bytes uri = 1;
  108. optional bytes revision = 2;
  109. }
  110. message ModifyReply {
  111. required bytes uri = 1;
  112. optional bytes revision = 2;
  113. }
  114. message PlaylistModificationInfo {
  115. optional bytes uri = 1;
  116. optional bytes new_revision = 2;
  117. }