beffd4967a
* Add possibility to omit the 'format' parameter * Allow it even when the 'file' storage is disabled Change-Id: Ib8dcad5f81499aec0ba147a3a4ef0b7a30995bcc
71 lines
2.6 KiB
Text
71 lines
2.6 KiB
Text
LibreOffice Online API
|
|
=======================
|
|
|
|
Document conversion:
|
|
- API: HTTP POST to /lool/convert-to/<format>
|
|
- the format is e.g. "png", "pdf" or "txt"
|
|
- the file itself in the payload
|
|
- example
|
|
- curl -F "data=@test.txt" https://localhost:9980/lool/convert-to/docx > out.docx
|
|
- or in html:
|
|
<form action="https://localhost:9980/lool/convert-to/docx" enctype="multipart/form-data" method="post">
|
|
File: <input type="file" name="data"><br/>
|
|
<input type="submit" value="Convert to DOCX">
|
|
</form>
|
|
|
|
- alternatively you can omit the <format>, and instead
|
|
provide it as another parameter
|
|
- example
|
|
- curl -F "data=@test.odt" -F "format=pdf" https://localhost:9980/lool/convert-to > out.pdf
|
|
- or in html:
|
|
<form action="https://localhost:9980/lool/convert-to" enctype="multipart/form-data" method="post">
|
|
File: <input type="file" name="data"><br/>
|
|
Format: <input type="text" name="format"><br/>
|
|
<input type="submit" value="Convert">
|
|
</form>
|
|
|
|
WOPI Extensions
|
|
===============
|
|
|
|
LibreOffice Online uses WOPI protocol to interact with hosts who wants to
|
|
integrate LibreOffice Online in them.
|
|
|
|
Refer to WOPI docs[https://wopi.readthedocs.io/en/latest/] for detailed
|
|
information. This documentation only mentions extensions to upstream WOPI protocol,
|
|
WOPI extensions, that are implemented by LibreOffice Online backend in addition to
|
|
upstream WOPI protocol.
|
|
|
|
(Please note that upstream WOPI implementation is also not 100% complete)
|
|
|
|
CheckFileInfo response properties
|
|
----------------------------------
|
|
|
|
HidePrintOption
|
|
If set to true, hides the print option from the filemenu bar in the UI
|
|
|
|
HideSaveOption
|
|
If set to true, hides the save button from the toolbar and file menubar
|
|
in the UI
|
|
|
|
HideExportOption
|
|
Hides 'Download as' option in the file menubar
|
|
|
|
DisablePrint
|
|
Disables print functionality in libreoffice online backend. If true,
|
|
HidePrintOption is assumed to be true
|
|
|
|
DisableExport
|
|
Disables export functionality in backend. If set to true,
|
|
HideExportOption is assumed to be true
|
|
|
|
DisableCopy
|
|
Disables copying from the document in libreoffice online
|
|
backend. Pasting into the document would still be possible.
|
|
However, it is still possible to do an "internal" cut/copy/paste.
|
|
|
|
EnableOwnerTermination
|
|
If set to true, it allows the document owner (the one with OwnerId =
|
|
UserId) to send a 'closedocument' message (see protocol.txt)
|
|
|
|
Note that it is possible to just hide print,save,export options while still
|
|
being able to access them from WOPI hosts using PostMessage API (see loleaflet/reference.html)
|