跳到主要内容

EditorConfigurationDto

How the editors behave for this opening: the mode, the language, the interface, and who is editing.

NameTypeDescriptionNotes
callbackUrlURI (uri)Where the editors post the document back to when they save it. A client must not call it itself; it is the address the document service uses.[optional] [example: https://portal.example.com/filehandler.ashx?action=track&fileid=512] [nullable]
coEditingCoEditingConfigDtoHow co-editing starts out for this session and whether the user may switch it in the interface.[optional]
createUrlStringWhere the editor sends the user when they ask for a new document of the same type. It is empty when creating one is not offered here.[optional] [example: https://portal.example.com/products/files/?action=create&doctype=word] [nullable]
customizationCustomizationConfigDtoHow the editor interface is dressed for this portal, this document and this layout.[optional]
embeddedEmbeddedConfigDtoThe addresses the framed viewer needs. It is filled in only for the embedded layout.[optional]
encryptionKeysListThe caller's end-to-end encryption keys, added only when the document lies in a private room, so that the editors can decrypt it in the browser. It is empty everywhere else.[optional] [nullable]
langStringThe culture the editor interface is shown in, taken from the profile of the caller.[required] [example: en-US] [nullable]
modeStringedit when this session may write the document, view when it may only read it.[required] [example: edit] [nullable]
modeWriteBooleanWhether this session may write; it is what the mode above says in one word.[optional] [example: true]
pluginsPluginsConfigDtoWhich editor plugins are offered. The portal currently offers none, so the list inside comes back empty.[optional]
recentListThe documents offered in the editor's recent list. It is left out altogether when there is nothing to offer.[optional] [example: []] [nullable]
templatesListAlways empty: the portal no longer passes creation templates through the editor configuration.[optional] [example: []] [nullable]
userUserConfigDtoThe account the editors attribute changes to. It is empty for an anonymous session opened through an external link, and the editors then ask for a name themselves.[optional]