plugins-nextcloud-mirror/richdocuments
1
0
Fork 0
mirror of https://github.com/nextcloud/richdocuments.git synced 2025-12-18 05:20:43 +01:00
Code Projects Releases Activity

Update documentation

Browse source 
Signed-off-by: Julius Härtl <jus@bitgrid.net>
This commit is contained in:
Julius Härtl 2020-07-16 19:10:43 +02:00
commit 00e02c06de
No known key found for this signature in database
GPG key ID: 4C614C6ED2CDE6DF
1 changed files with 23 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/frontend-integration.md
View file

@ -35,15 +35,15 @@ The following two methods are exposed in order to manually trigger the Collabora
Params requires the following properties:
- fileId: (string) internal file id
- path: (string) full path to the file
- shareOwnerId: (string) uid of share owner for shared files
- fileList: (object) optional file list object (see limitations below when not passing it)
- fileModel: (OCA.Files.FileInfoModel) model of the file that will be opened
- fileList: (object) optional file list object
```javascript
OCA.RichDocuments.open({
fileId: 1234,
path: '/path/to/file.odt',
shareOwnerId: 'admin@nextcloud',
fileModel: new OCA.Files.FileInfoModel({...})
fileList: FileList
})
```
@ -55,15 +55,27 @@ OCA.RichDocuments.open({
Params requires the following properties:
- fileId: (string) internal file id
- path: (string) full path to the file
- shareOwnerId: (string) uid of share owner for shared files
- fileList: (object) optional file list object (see limitations below when not passing it)
- templateId: (string) file id of the template
- fileModel: (OCA.Files.FileInfoModel) model of the file that will be opened
- fileList: (object) optional file list object
```javascript
OCA.RichDocuments.openWithTemplate({
fileId: -1,
path: '/path/to/file.odt,
templateId: templateId
templateId: templateId,
fileModel: new OCA.Files.FileInfoModel({...})
})
```
Changes to the fileModel should be propagated by triggering a backbone `change` event:
```javascript
window.OCA.RichDocuments.FilesAppIntegration.registerHandler('actionFavorite', (filesAppIntegration) => {
// custom logic here
// make sure to trigger a change on the file info model object like this:
filesAppIntegration.getFileModel().trigger('change', newFileModel)
return true
})
```
@ -81,6 +93,11 @@ The following handlers are currently supported:
- rename: will be called before the default rename action is triggered (the new filename is available as a property of the filesAppIntegration parameter)
- showRevHistory: will be called before the default show revision history action is triggered
In addition, the following handlers can be used to overwrite the handling of file actions that are rendered in the Nextcloud header bar:
- actionDetails
- actionDownload
- actionFavorite
The filesAppIntegration parameter can be used to extract the current context of the edited file. The following properties are available for that:
- fileName
- fileId