More flow docs

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2018-09-04 19:50:29 +02:00
commit 47e187ec94
No known key found for this signature in database
GPG key ID: F941078878347C0C

46
docs/mobile_flow.md Normal file
View file

@ -0,0 +1,46 @@
# Mobile flow
To enable collabora editor into a client there are a few things that need to be
care off.
## 1. Check for support
Check the capabilities API
`<server>/ocs/v2.php/cloud/capabilities`
If this contains a richdocument section then mobile editing is supported.
There is a list of mimetypes that can be edited with collabora supplied.
## 2. Open a file with a fileid
This happens via the OCS api described [here](./mobile_editor.md)
This returns an URL that you have to open in a full screen webview.
Be sure to have javascript enabled.
## 3. Interacting with the document
The richdocuments app looks for a javscript handler that the client can
register. This is: `RichDocumentsMobileInterface`
It expects the following functions:
### close()
This closed the webview.
### insertGraphic()
open a filepicker to select a file from your nextcloud.
The file has to be submitted to the [asset api](./asset_api.md).
Then the client has to call the function (on the webui):
`OCA.RichDocuments.documentsMain.postAsset(filename, url)`
This will make sure the assets is added to the document.
### share()
opens the share sidebar for the current file