Skip to main content

DocumentViewer

warning

This API is partially documented or under construction.

Overview​

Synology Document Viewer API implementation.

Provides read-only access to document conversion status and index information.

Methods​

get_index_list​

Get the document viewer index list.

Internal API​

SYNO.DocumentViewer.Index

Returns​

dict[str, object] or str
Index list or error message.


get_convert_info​

Get the document conversion information.

Internal API​

SYNO.DocumentViewer.Convert

Returns​

dict[str, object] or str
Conversion info or error message.


get_poll_status​

Get the document conversion poll status.

Internal API​

SYNO.DocumentViewer.Convert

Returns​

dict[str, object] or str
Poll status or error message.