Added PREVIEW as an additional ViewMode for apps (#179)

cs3org · Sep 5, 2022 · dd6c85f · dd6c85f
1 parent a9392fb
commit dd6c85f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 2 deletions.
diff --git a/cs3/app/provider/v1beta1/provider_api.proto b/cs3/app/provider/v1beta1/provider_api.proto
@@ -73,8 +73,14 @@ message OpenInAppRequest {
     VIEW_MODE_VIEW_ONLY = 1;
     // The resource can be downloaded.
     VIEW_MODE_READ_ONLY = 2;
-    // The resource can be downloaded and updated.
+    // The resource can be downloaded and updated. The underlying application
+    // MUST be a fully capable editor to support this mode.
     VIEW_MODE_READ_WRITE = 3;
+    // The resource can be downloaded and updated, but must be shown in
+    // preview mode. If the underlying application does not support a preview mode,
+    // or if in a view-only mode users are not allowed to switch to edit mode,
+    // then this mode MUST fall back to READ_WRITE.
+    VIEW_MODE_PREVIEW = 4;
   }
   ViewMode view_mode = 3;
   // REQUIRED.

diff --git a/docs/index.html b/docs/index.html
@@ -5611,7 +5611,17 @@ <h3 id="cs3.app.provider.v1beta1.OpenInAppRequest.ViewMode">OpenInAppRequest.Vie
               <tr>
                 <td>VIEW_MODE_READ_WRITE</td>
                 <td>3</td>
-                <td><p>The resource can be downloaded and updated.</p></td>
+                <td><p>The resource can be downloaded and updated. The underlying application
+MUST be a fully capable editor to support this mode.</p></td>
+              </tr>
+
+              <tr>
+                <td>VIEW_MODE_PREVIEW</td>
+                <td>4</td>
+                <td><p>The resource can be downloaded and updated, but must be shown in
+preview mode. If the underlying application does not support a preview mode,
+or if in a view-only mode users are not allowed to switch to edit mode,
+then this mode MUST fall back to READ_WRITE.</p></td>
               </tr>
 
           </tbody>