mirror of
https://github.com/nextcloud/richdocuments.git
synced 2025-12-18 05:20:43 +01:00
More flow docs
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
parent
76a6f15350
commit
47e187ec94
1 changed files with 46 additions and 0 deletions
46
docs/mobile_flow.md
Normal file
46
docs/mobile_flow.md
Normal 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
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue