package cs3.app.provider.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

App Provider API The App Provider API is responsible for creating URLs that will render a viewer or editor for the given resource, typically via WOPI protocol. For example, a Collabora or HackMD editor. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc OpenInApp (OpenInAppRequest, OpenInAppResponse)

  provider_api.proto:58

  Returns the App URL and all necessary info to open a resource in an online editor. MUST return CODE_NOT_FOUND if the resource does not exist.

  message OpenInAppRequest

  provider_api.proto:61

  • optional types.v1beta1.Opaque opaque = 1

    OPTIONAL. Opaque information.

  • optional storage.provider.v1beta1.ResourceInfo resource_info = 2

    REQUIRED. The resourceInfo to be opened. The gateway grpc message has a ref instead.

  • ViewMode view_mode = 3

    REQUIRED. View mode.

  • string access_token = 4

    REQUIRED. The access token this application provider will use when contacting the storage provider to read and write. Service implementors MUST make sure that the access token only grants access to the requested resource. Service implementors should use a ResourceId rather than a filepath to grant access, as ResourceIds MUST NOT change when a resource is renamed. The access token MUST be short-lived. TODO(labkode): investigate token derivation techniques.

Used as response type in: ProviderAPI.OpenInApp, gateway.v1beta1.GatewayAPI.OpenInApp

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional OpenInAppURL app_url = 3

  REQUIRED. The url that user agents will render to clients. Usually the rendering happens by using HTML iframes or in separate browser tabs.

• string forced_view_mode_reason = 4

  OPTIONAL. A reason in case the requested view_mode was overridden due to e.g. external locks.

Represents the information for the app URL to be called by the clients.

Used in: OpenInAppResponse

• string app_url = 1

  REQUIRED. The URL that clients will perform requests to.

• string method = 2

  REQUIRED. The method for the request to be made. Only GET and POST are supported.

• map<string, string> form_parameters = 3

  OPTIONAL. The form parameters which have to be passed along with the request. These are sent only if the method is 'POST'.

• map<string, string> headers = 4

  OPTIONAL. The headers to be added to the request.

• Target target = 5

  REQUIRED. Whether the target for the app URL is an iframe or a new page.

Defines the valid targets for an app URL.

Used in: OpenInAppURL

• TARGET_INVALID = 0

• TARGET_IFRAME = 1

  The app URL is to be opened within an iframe

• TARGET_BLANK = 2

  The app URL is to be opened on a new blank page

Defines the view modes.

Used in: OpenInAppRequest

• VIEW_MODE_INVALID = 0

• VIEW_MODE_VIEW_ONLY = 1

  The resource can be opened but not downloaded.

• VIEW_MODE_READ_ONLY = 2

  The resource can be downloaded.

• VIEW_MODE_READ_WRITE = 3

  The resource can be downloaded and updated. The underlying application MUST be a fully capable editor to support this mode.

• VIEW_MODE_PREVIEW = 4

  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_EMBEDDED = 5

  The resource can be viewed in embedded mode. Editing is disabled.