Index (com.onlyoffice:docs-integration-sdk 1.3.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W Z

A

Action - Class in com.onlyoffice.model.documenteditor.callback: Defines the object received when the user takes an action with the document.
Action() - Constructor for class com.onlyoffice.model.documenteditor.callback.Action
actionLink - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Specifies the data received from the document editing service using the "onMakeActionLink" event or the "onRequestSendNotify" event in "data.actionLink" parameter, which contains the information about the action in the document that will be scrolled to.
actions - Variable in class com.onlyoffice.model.common.Format: Defines a list of actions that can be performed with the current document format.
actions - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the object received when the user takes an action with the document.
address - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the postal address of the company or person who gives access to the editors or the editor authors.
Anonymous - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Adds a request for the anonymous name.
anonymous - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Adds a request for the anonymous name.
Anonymous() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Anonymous
apiPreloaderUrl - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
apiUrl - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
aspect - Variable in class com.onlyoffice.model.convertservice.convertrequest.Thumbnail: Defines the mode to fit the image to the height and width specified.
async - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the conversion request type: asynchronous or not.
author - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Deprecated.
autosave - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the "Autosave" menu option is enabled or disabled.
autostart - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Plugins: Defines an array of the identifiers (as entered in "config.json") for the plugins, which will automatically start when the editor opens, and the order the plugins will run one-by-one.

B

blank - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Goback: Opens the website in the new browser tab/window (if the value is set to "true") or the current tab (if the value is set to "false") when the "Open file location" button is clicked.
BY_CODE - Static variable in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Defines a map of the Error objects with the Command Service error codes.
BY_CODE - Static variable in enum com.onlyoffice.model.common.CommonResponse.Error: Defines a map of the Error objects with the common error codes.
BY_CODE - Static variable in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Defines a map of the Error objects with the Conversion Service error codes.
BY_ID - Static variable in enum com.onlyoffice.model.documenteditor.callback.action.Type: Defines a map of the action types with their IDs.
BY_ID - Static variable in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Defines a map of the force saving request types with their IDs.
BY_ID - Static variable in enum com.onlyoffice.model.documenteditor.callback.Status: Defines a map of the statuses with their IDs.

C

c - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines the command type.
Callback - Class in com.onlyoffice.model.documenteditor: Defines the callback handler parameters.
Callback() - Constructor for class com.onlyoffice.model.documenteditor.Callback
CallbackService - Interface in com.onlyoffice.service.documenteditor.callback
callbackUrl - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Specifies absolute URL to the document storage service (which must be implemented by the software integrators who use ONLYOFFICE Document Server on their own server).
change - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.CoEditing: Defines if the co-editing mode can be changed in the editor interface or not.
changes - Variable in class com.onlyoffice.model.documenteditor.callback.History: Defines the changes from the history object returned after saving the document.
changes - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the changes from the history object returned after saving the document.
changesurl - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the link to the file with the document editing data used to track and display the document changes history.
changesUrl - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the url address of the file with the document changes data, which can be downloaded by the changesurl link from the JSON object returned after saving the document.
chat - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the chat functionality is enabled in the document or not.
chat - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
checkCommandService() - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkCommandService(String, Security, HttpClientSettings) - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkCommandService() - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Command Service.
checkCommandService(String, Security, HttpClientSettings) - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Command Service by the Document Server URL.
checkConvertService() - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkConvertService(String, String, Security, HttpClientSettings) - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkConvertService() - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Convert Service.
checkConvertService(String, String, Security, HttpClientSettings) - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Convert Service by the Document Server URL.
checkDocumentServer() - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkDocumentServer(String, HttpClientSettings) - Method in class com.onlyoffice.service.settings.DefaultSettingsValidationService
checkDocumentServer() - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Document Server.
checkDocumentServer(String, HttpClientSettings) - Method in interface com.onlyoffice.service.settings.SettingsValidationService: Checks the Document Server by its URL.
Close - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization
close - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines settings for the cross button to close the editor.
Close() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Close
code - Variable in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Defines the error code.
code - Variable in enum com.onlyoffice.model.common.CommonResponse.Error: Defines the error code.
code - Variable in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Defines the error code.
codePage - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the file encoding when converting from "csv" or "txt" format.
CoEditing - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the co-editing mode ("Fast" or "Strict") and the possibility to change it.
coEditing - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the co-editing mode ("Fast" or "Strict") and the possibility to change it.
CoEditing() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.CoEditing
com.onlyoffice.manager.document - package com.onlyoffice.manager.document
com.onlyoffice.manager.request - package com.onlyoffice.manager.request
com.onlyoffice.manager.security - package com.onlyoffice.manager.security
com.onlyoffice.manager.settings - package com.onlyoffice.manager.settings
com.onlyoffice.manager.url - package com.onlyoffice.manager.url
com.onlyoffice.model.commandservice - package com.onlyoffice.model.commandservice
com.onlyoffice.model.commandservice.commandrequest - package com.onlyoffice.model.commandservice.commandrequest
com.onlyoffice.model.common - package com.onlyoffice.model.common
com.onlyoffice.model.convertservice - package com.onlyoffice.model.convertservice
com.onlyoffice.model.convertservice.convertrequest - package com.onlyoffice.model.convertservice.convertrequest
com.onlyoffice.model.documenteditor - package com.onlyoffice.model.documenteditor
com.onlyoffice.model.documenteditor.callback - package com.onlyoffice.model.documenteditor.callback
com.onlyoffice.model.documenteditor.callback.action - package com.onlyoffice.model.documenteditor.callback.action
com.onlyoffice.model.documenteditor.config - package com.onlyoffice.model.documenteditor.config
com.onlyoffice.model.documenteditor.config.document - package com.onlyoffice.model.documenteditor.config.document
com.onlyoffice.model.documenteditor.config.document.info - package com.onlyoffice.model.documenteditor.config.document.info
com.onlyoffice.model.documenteditor.config.document.info.sharingsettings - package com.onlyoffice.model.documenteditor.config.document.info.sharingsettings
com.onlyoffice.model.documenteditor.config.document.permissions - package com.onlyoffice.model.documenteditor.config.document.permissions
com.onlyoffice.model.documenteditor.config.editorconfig - package com.onlyoffice.model.documenteditor.config.editorconfig
com.onlyoffice.model.documenteditor.config.editorconfig.coediting - package com.onlyoffice.model.documenteditor.config.editorconfig.coediting
com.onlyoffice.model.documenteditor.config.editorconfig.customization - package com.onlyoffice.model.documenteditor.config.editorconfig.customization
com.onlyoffice.model.documenteditor.config.editorconfig.customization.review - package com.onlyoffice.model.documenteditor.config.editorconfig.customization.review
com.onlyoffice.model.documenteditor.config.editorconfig.embedded - package com.onlyoffice.model.documenteditor.config.editorconfig.embedded
com.onlyoffice.model.documenteditor.formdata - package com.onlyoffice.model.documenteditor.formdata
com.onlyoffice.model.documenteditor.history - package com.onlyoffice.model.documenteditor.history
com.onlyoffice.model.documenteditor.historydata - package com.onlyoffice.model.documenteditor.historydata
com.onlyoffice.model.properties - package com.onlyoffice.model.properties
com.onlyoffice.model.properties.docsintegrationsdk - package com.onlyoffice.model.properties.docsintegrationsdk
com.onlyoffice.model.properties.docsintegrationsdk.documentserver - package com.onlyoffice.model.properties.docsintegrationsdk.documentserver
com.onlyoffice.model.settings - package com.onlyoffice.model.settings
com.onlyoffice.model.settings.security - package com.onlyoffice.model.settings.security
com.onlyoffice.model.settings.validation - package com.onlyoffice.model.settings.validation
com.onlyoffice.model.settings.validation.status - package com.onlyoffice.model.settings.validation.status
com.onlyoffice.service.command - package com.onlyoffice.service.command
com.onlyoffice.service.convert - package com.onlyoffice.service.convert
com.onlyoffice.service.documenteditor.callback - package com.onlyoffice.service.documenteditor.callback
com.onlyoffice.service.documenteditor.config - package com.onlyoffice.service.documenteditor.config
com.onlyoffice.service.settings - package com.onlyoffice.service.settings
com.onlyoffice.utils - package com.onlyoffice.utils
Command - Enum in com.onlyoffice.model.commandservice.commandrequest: Defines the command type.
Command() - Constructor for enum com.onlyoffice.model.commandservice.commandrequest.Command
CommandRequest - Class in com.onlyoffice.model.commandservice: Defines the request parameters that are sent to the "https://documentserver/command" address where "documentserver" is the name of the server with the ONLYOFFICE Document Server installed.
CommandRequest() - Constructor for class com.onlyoffice.model.commandservice.CommandRequest
CommandResponse - Class in com.onlyoffice.model.commandservice: Defines the response parameters that are received from the document command service.
CommandResponse() - Constructor for class com.onlyoffice.model.commandservice.CommandResponse
CommandResponse.Error - Enum in com.onlyoffice.model.commandservice: Defines the Command Service error codes.
commandService - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
CommandService - Interface in com.onlyoffice.service.command
CommandServiceProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk.documentserver
CommandServiceProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.CommandServiceProperties
comment - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the document can be commented or not.
commentAuthorOnly - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
CommentGroups - Class in com.onlyoffice.model.documenteditor.config.document.permissions: Defines the groups whose comments the user can edit, remove and/or view.
commentGroups - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines the groups whose comments the user can edit, remove and/or view.
CommentGroups() - Constructor for class com.onlyoffice.model.documenteditor.config.document.permissions.CommentGroups
comments - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the "Comments" menu button is displayed or hidden.
CommonResponse - Class in com.onlyoffice.model.common: Defines the response parameters that are received from the Document Server.
CommonResponse() - Constructor for class com.onlyoffice.model.common.CommonResponse
CommonResponse.Error - Enum in com.onlyoffice.model.common: Defines the Document Server error codes.
compactHeader - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the additional action buttons are displayed in the upper part of the editor window header next to the logo ("false") or in the toolbar ("true") making the header more compact.
compactToolbar - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the top toolbar type displayed is full ("false") or compact ("true").
compatibleFeatures - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the use of functionality only compatible with the OOXML format.
Config - Class in com.onlyoffice.model.documenteditor: Defines the Document Server config.
Config() - Constructor for class com.onlyoffice.model.documenteditor.Config
ConfigService - Interface in com.onlyoffice.service.documenteditor.config
ConfigurationUtils - Class in com.onlyoffice.utils
ConfigurationUtils() - Constructor for class com.onlyoffice.utils.ConfigurationUtils
connectionRequestTimeout - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.HttpClientProperties
connectionRequestTimeout - Variable in class com.onlyoffice.model.settings.HttpClientSettings
connectionTimeout - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.HttpClientProperties
connectionTimeout - Variable in class com.onlyoffice.model.settings.HttpClientSettings
convert - Variable in class com.onlyoffice.model.common.Format: Defines a list of extensions to which the current format can be converted.
convertObjectToDotNotationMap(T) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
ConvertRequest - Class in com.onlyoffice.model.convertservice
ConvertRequest() - Constructor for class com.onlyoffice.model.convertservice.ConvertRequest
ConvertResponse - Class in com.onlyoffice.model.convertservice: Defines the response parameters that are received from the document conversion service.
ConvertResponse() - Constructor for class com.onlyoffice.model.convertservice.ConvertResponse
ConvertResponse.Error - Enum in com.onlyoffice.model.convertservice: Defines the Conversion Service error codes.
convertService - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
ConvertService - Interface in com.onlyoffice.service.convert
ConvertServiceProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk.documentserver
ConvertServiceProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.ConvertServiceProperties
copy - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the content can be copied to the clipboard or not.
createConfig(String, Mode, String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Creates a configuration for the document editor using the User-Agent request header.
createConfig(String, Mode, Type) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Creates a configuration for the document editor using the Type parameter.
createConfig(String, Mode, String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
createConfig(String, Mode, Type) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
created - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Deprecated.
created - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the document version creation date.
createPostRequest(String, RequestEntity, Security) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
createToken(Object) - Method in class com.onlyoffice.manager.security.DefaultJwtManager
createToken(Object, String) - Method in class com.onlyoffice.manager.security.DefaultJwtManager
createToken(Map<String, ?>, String) - Method in class com.onlyoffice.manager.security.DefaultJwtManager
createToken(Object) - Method in interface com.onlyoffice.manager.security.JwtManager: Creates a new JWT for the specified object using the key from SettingsManager.
createToken(Object, String) - Method in interface com.onlyoffice.manager.security.JwtManager: Creates a new JWT for the specified object.
createToken(Map<String, ?>, String) - Method in interface com.onlyoffice.manager.security.JwtManager: Creates a new JWT for the specified payload map.
createUrl - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the absolute URL of the document where it will be created and available after creation.
currentVersion - Variable in class com.onlyoffice.model.documenteditor.History: Defines the current document version number.
Customer - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Contains the information which will be displayed in the editor "About" section and visible to all the editor users.
customer - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Contains the information which will be displayed in the editor "About" section and visible to all the editor users.
Customer() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer
Customization - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the parameters to customize the editor interface so that it looked like your other products (if there are any) and change the presence or absence of the additional buttons, links, change logos and editor owner details.
customization - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the parameters to customize the editor interface so that it looked like your other products (if there are any) and change the presence or absence of the additional buttons, links, change logos and editor owner details.
Customization() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.Customization
customization - Variable in class com.onlyoffice.model.settings.Settings: Defines the parameters to customize the editor interface so that it looked like your other products (if there are any) and change the presence or absence of the additional buttons, links, change logos and editor owner details.

D

DEFAULT_MAX_FILE_SIZE - Static variable in class com.onlyoffice.manager.document.DefaultDocumentManager: Defines the default maximum file size, used if the "integration-sdk.data.filesize.editing.max" or "integration-sdk.data.filesize.conversion.max" properties are not specified in "settings.properties".
DefaultCallbackService - Class in com.onlyoffice.service.documenteditor.callback
DefaultCallbackService() - Constructor for class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
DefaultCommandService - Class in com.onlyoffice.service.command
DefaultCommandService() - Constructor for class com.onlyoffice.service.command.DefaultCommandService
DefaultConfigService - Class in com.onlyoffice.service.documenteditor.config
DefaultConfigService() - Constructor for class com.onlyoffice.service.documenteditor.config.DefaultConfigService
DefaultConvertService - Class in com.onlyoffice.service.convert
DefaultConvertService() - Constructor for class com.onlyoffice.service.convert.DefaultConvertService
DefaultDocumentManager - Class in com.onlyoffice.manager.document
DefaultDocumentManager() - Constructor for class com.onlyoffice.manager.document.DefaultDocumentManager
DefaultJwtManager - Class in com.onlyoffice.manager.security
DefaultJwtManager() - Constructor for class com.onlyoffice.manager.security.DefaultJwtManager
DefaultRequestManager - Class in com.onlyoffice.manager.request
DefaultRequestManager() - Constructor for class com.onlyoffice.manager.request.DefaultRequestManager
DefaultSettingsManager - Class in com.onlyoffice.manager.settings
DefaultSettingsManager() - Constructor for class com.onlyoffice.manager.settings.DefaultSettingsManager
DefaultSettingsValidationService - Class in com.onlyoffice.service.settings
DefaultSettingsValidationService() - Constructor for class com.onlyoffice.service.settings.DefaultSettingsValidationService
DefaultUrlManager - Class in com.onlyoffice.manager.url
DefaultUrlManager() - Constructor for class com.onlyoffice.manager.url.DefaultUrlManager
deleteCommentAuthorOnly - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the user can delete only his/her comments.
delimiter - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the delimiter characters for separating values when converting from "csv" format.
demo - Variable in class com.onlyoffice.model.settings.Settings: Specifies whether the demo editor is enabled.
DEMO - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the demo editor.
DEMO_SECURITY_HEADER - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The demo security header.
DEMO_SECURITY_KEY - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The demo security key.
DEMO_SECURITY_PREFIX - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The demo security prefix.
DEMO_TRIAL_PERIOD - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The number of days that the demo server can be used.
DEMO_URL - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The demo security url.
description - Variable in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Defines the error description.
description - Variable in enum com.onlyoffice.model.common.CommonResponse.Error: Defines the error description.
description - Variable in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Defines the error description.
disableDemo() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
disableDemo() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Disables the use of the demo editor.
docbuilderService - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
DocbuilderServiceProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk.documentserver
DocbuilderServiceProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.DocbuilderServiceProperties
DOCS_FORMATS_JSON_PATH - Static variable in class com.onlyoffice.manager.document.DefaultDocumentManager: Path to the matrix of formats supported by the ONLYOFFICE Editor.
DocsIntegrationSdkProperties - Class in com.onlyoffice.model.properties
DocsIntegrationSdkProperties() - Constructor for class com.onlyoffice.model.properties.DocsIntegrationSdkProperties
docsIntegrationSdkProperties - Static variable in class com.onlyoffice.utils.ConfigurationUtils: DocsIntegrationSdkProperties.
Document - Class in com.onlyoffice.model.documenteditor.config: Defines the document parameters.
document - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the document parameters.
Document() - Constructor for class com.onlyoffice.model.documenteditor.config.Document
DocumentManager - Interface in com.onlyoffice.manager.document
documentManager - Variable in class com.onlyoffice.service.convert.DefaultConvertService: DocumentManager.
documentManager - Variable in class com.onlyoffice.service.documenteditor.config.DefaultConfigService: DocumentManager.
documentServer - Variable in class com.onlyoffice.model.properties.DocsIntegrationSdkProperties
DocumentServerProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk
DocumentServerProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
DocumentType - Enum in com.onlyoffice.model.documenteditor.config.document: Defines the document type to be opened.
DocumentType() - Constructor for enum com.onlyoffice.model.documenteditor.config.document.DocumentType
documentType - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the document type to be opened.
download - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the document can be downloaded or only viewed or edited online.
doWork(Object) - Method in interface com.onlyoffice.manager.request.RequestManager.Callback: The callback method.

E

edit - Variable in class com.onlyoffice.model.documenteditor.config.document.permissions.CommentGroups: Defines a list of groups whose comments the user can edit.
edit - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the document can be edited or only viewed.
editCommentAuthorOnly - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the user can edit only his/her comments.
editingService - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
EditingServiceProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk.documentserver
EditingServiceProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.EditingServiceProperties
EditorConfig - Class in com.onlyoffice.model.documenteditor.config: Defines the editor interface parameters.
editorConfig - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the editor interface parameters.
EditorConfig() - Constructor for class com.onlyoffice.model.documenteditor.config.EditorConfig
Embedded - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the parameters for the embedded document type only (see the Config section to find out how to define the embedded document type).
embedded - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the parameters for the embedded document type only (see the Config section to find out how to define the embedded document type).
Embedded() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded
embedUrl - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded: Defines the absolute URL to the document serving as a source file for the document embedded into the web page.
enableDemo() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
enableDemo() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Checks whether the demo editor is enabled.
endConvert - Variable in class com.onlyoffice.model.convertservice.ConvertResponse: Defines if the conversion is completed or not.
error - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines an error code.
Error() - Constructor for enum com.onlyoffice.model.commandservice.CommandResponse.Error
error - Variable in class com.onlyoffice.model.common.CommonResponse: Defines an error code.
Error() - Constructor for enum com.onlyoffice.model.common.CommonResponse.Error
Error - Interface in com.onlyoffice.model.common: Defines the error parameters.
error - Variable in class com.onlyoffice.model.convertservice.ConvertResponse: Defines an error occurred during the conversion.
Error() - Constructor for enum com.onlyoffice.model.convertservice.ConvertResponse.Error
error - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the error message text.
error - Variable in class com.onlyoffice.model.settings.validation.ValidationResult: Defines the error parameters.
executeGetRequest(String, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
executeGetRequest(String, HttpClientSettings, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
executeGetRequest(String, RequestManager.Callback<R>) - Method in interface com.onlyoffice.manager.request.RequestManager: Executes a GET request to the url.
executeGetRequest(String, HttpClientSettings, RequestManager.Callback<R>) - Method in interface com.onlyoffice.manager.request.RequestManager: Executes a GET request to the url.
executePostRequest(RequestedService, RequestEntity, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
executePostRequest(RequestedService, RequestEntity, HttpClientSettings, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
executePostRequest(String, RequestEntity, Security, HttpClientSettings, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
executePostRequest(RequestedService, RequestEntity, RequestManager.Callback<R>) - Method in interface com.onlyoffice.manager.request.RequestManager: Executes a POST request to the specified service.
executePostRequest(RequestedService, RequestEntity, HttpClientSettings, RequestManager.Callback<R>) - Method in interface com.onlyoffice.manager.request.RequestManager: Executes a POST request to the url.
executePostRequest(String, RequestEntity, Security, HttpClientSettings, RequestManager.Callback<R>) - Method in interface com.onlyoffice.manager.request.RequestManager: Executes a POST request to the url.
executeRequest(HttpUriRequest, HttpClientSettings, RequestManager.Callback<R>) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
extra - Variable in class com.onlyoffice.model.settings.Settings

F

favorite - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Defines the highlighting state of the "Favorite" icon.
Features - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Defines the parameters that the user can disable or customize if possible.
features - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the parameters that the user can disable or customize if possible.
Features() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Features
feedback - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the "Feedback & Support" menu button is displayed or hidden.
fileKey - Variable in class com.onlyoffice.model.documenteditor.config.document.ReferenceData: Defines the unique document identifier used by the service to get a link to the file.
filetype - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the type of the document file to be converted.
fileType - Variable in class com.onlyoffice.model.convertservice.ConvertResponse: Defines an extension of the converted file.
filetype - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines an extension of the document that is downloaded from the link specified with the url parameter.
fileType - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the type of the file for the source viewed or edited document.
fileType - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines an extension of the document specified with the "url" parameter.
fileType - Variable in class com.onlyoffice.model.documenteditor.historydata.Previous: Defines an extension of the document specified with the "previous.url" parameter.
fileUrl - Variable in class com.onlyoffice.model.convertservice.ConvertResponse: Defines the link to the converted document.
fillForms - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the forms can be filled.
first - Variable in class com.onlyoffice.model.convertservice.convertrequest.Thumbnail: Defines if the thumbnails should be generated for the first page only or for all the document pages.
folder - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Defines the folder where the document is stored (can be empty in case the document is stored in the root folder).
folder - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Recent: Defines the folder where the document is stored (can be empty in case the document is stored in the root folder).
forcesave - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Adds the request for the file force saving to the callback handler when saving the document within the document editing service (e.g.
ForcesaveType - Enum in com.onlyoffice.model.documenteditor.callback: Defines the type of initiator when the force saving request is performed.
forcesavetype - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the type of initiator when the force saving request is performed.
ForcesaveType() - Constructor for enum com.onlyoffice.model.documenteditor.callback.ForcesaveType
form - Variable in class com.onlyoffice.model.convertservice.convertrequest.PDF: Defines whether the document will be converted to the pdf form (true) or to a regular pdf file (false).
Format - Class in com.onlyoffice.model.common: Defines the document format properties.
Format() - Constructor for class com.onlyoffice.model.common.Format
formats - Static variable in class com.onlyoffice.manager.document.DefaultDocumentManager: Defines a list containing data about supported formats.
FormData - Class in com.onlyoffice.model.documenteditor: Defines the submitted form data.
FormData() - Constructor for class com.onlyoffice.model.documenteditor.FormData
formsdataurl - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the URL to the JSON file with the submitted form data.
FormSpecificType - Enum in com.onlyoffice.model.documenteditor.formdata
FormSpecificType() - Constructor for enum com.onlyoffice.model.documenteditor.formdata.FormSpecificType
fullscreenUrl - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded: Defines the absolute URL to the document which will open in full screen mode.

G

getBaseName(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getBaseName(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the file base name without the full path and extension.
getCallbackUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getCallbackUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the callback handler.
getCode() - Method in interface com.onlyoffice.model.common.Error: Returns the error code.
getCoEditing(String, Mode, Type) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the CoEditing object.
getCoEditing(String, Mode, Type) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getCompareFileExtensions() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getCompareFileExtensions() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a list of extensions that can be used for the document comparison functions.
getConvertExtensionList(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getConvertExtensionList(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a list of extensions that the document with the name specified in the request can be converted to.
getCreateUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getCreateUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to create a new file with the ID specified in the request.
getCustomization(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Customization object.
getCustomization(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getDefaultConvertExtension(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getDefaultConvertExtension(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the default OOXML extension to which the document with the name specified in the request should be converted.
getDefaultExtension(DocumentType) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getDefaultExtension(DocumentType) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the default OOXML extension by the specified document type.
getDemoDocumentServerProperties() - Static method in class com.onlyoffice.utils.ConfigurationUtils: Returns connection settings to the demo server.
getDemoTrialPeriod() - Static method in class com.onlyoffice.utils.ConfigurationUtils: Returns the number of days that the demo server can be used.
getDescription() - Method in interface com.onlyoffice.model.common.Error: Returns the error description.
getDocsIntegrationSdkProperties() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getDocsIntegrationSdkProperties() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns Docs Integration SDK Properties.
getDocsIntegrationSdkProperties() - Static method in class com.onlyoffice.utils.ConfigurationUtils: Returns Docs Integration Sdk Properties.
getDocument(String, Type) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Document object.
getDocument(String, Type) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getDocumentKey(String, boolean) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getDocumentKey(String, boolean) - Method in interface com.onlyoffice.manager.document.DocumentManager: Generates a unique document identifier used by the service to recognize the document.
getDocumentName(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getDocumentName(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the document name by file ID.
getDocumentServerApiUrl() - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getDocumentServerApiUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getDocumentServerApiUrl() - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the Document Server API.
getDocumentServerApiUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the Document Server API with shardKey.
getDocumentServerPreloaderApiUrl() - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getDocumentServerPreloaderApiUrl() - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the Document Server Preloader API.
getDocumentServerUrl() - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getDocumentServerUrl() - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the Document Server.
getDocumentType(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getDocumentType(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the document type by the file name.
getEditorConfig(String, Mode, Type) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the EditorConfig object.
getEditorConfig(String, Mode, Type) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getEmbedded(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Embedded object.
getEmbedded(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getExtension(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getExtension(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the file extension from the file name.
getFileUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getFileUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to download a file with the ID specified in the request.
getFormats() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getFormats() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a list of file formats (electronic documents, forms, spreadsheets, presentations) supported by the ONLYOFFICE editors.
getGobackUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getGobackUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the location folder of a file with the ID specified in the request.
getHttpClient(HttpClientSettings) - Method in class com.onlyoffice.manager.request.DefaultRequestManager
getId() - Method in enum com.onlyoffice.model.documenteditor.callback.action.Type: Returns the action type ID.
getId() - Method in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Returns the ID of the force saving request type.
getId() - Method in enum com.onlyoffice.model.documenteditor.callback.Status: Returns the status ID.
getInfo(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Info object.
getInfo(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getInnerDocumentServerUrl() - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getInnerDocumentServerUrl() - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the inner URL to the Document Server.
getInsertImage() - Method in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.EditingServiceProperties
getInsertImageExtensions() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getInsertImageExtensions() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a list of image extensions that can be inserted into the document.
getKey() - Method in interface com.onlyoffice.model.common.RequestEntity: Returns a key from the request.
getLossyEditableMap() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getLossyEditableMap() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a map of extensions that can be edited with the possible loss of information.
getMailMergeExtensions() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getMailMergeExtensions() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns a list of extensions that can be used for mail merge in the document.
getMaxConversionFileSize() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getMaxConversionFileSize() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the maximum file size that can be converted in the ONLYOFFICE Conversion Service.
getMaxFileSize() - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getMaxFileSize() - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns the maximum file size that can be opened in the ONLYOFFICE editor.
getNamesSettings(T) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getNewBlankFile(String, Locale) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
getNewBlankFile(String, Locale) - Method in interface com.onlyoffice.manager.document.DocumentManager: Returns InputStream of an empty file with the given extension and locale.
getPermissions(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Permissions object.
getPermissions(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getPlugins(Object) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Plugins object.
getPlugins(Object) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getRecent(Object) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns a list of the Recent objects.
getRecent(Object) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getReferenceData(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the ReferenceData object.
getReferenceData(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getSecurityHeader() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSecurityHeader() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns the authorization header.
getSecurityKey() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSecurityKey() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns the security key.
getSecurityPrefix() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSecurityPrefix() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns the authorization prefix.
getServiceUrl(RequestedService) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getServiceUrl(RequestedService) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the service using the requested service properties specified in the request.
getSetting(String) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSetting(String) - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns a value of the setting with the name specified in the request.
getSettingBoolean(String, Boolean) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSettingBoolean(String, Boolean) - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns a boolean value of the setting with the name specified in the request.
getSettings() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
getSettings() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Returns a map of the settings.
getTemplates(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns a list of the Template objects.
getTemplates(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getTestConvertUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
getTestConvertUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Returns the URL to the test file.
getToken() - Method in class com.onlyoffice.model.commandservice.CommandRequest: Returns a token from the command request.
getToken() - Method in interface com.onlyoffice.model.common.RequestEntity: Returns a token from the request.
getToken() - Method in class com.onlyoffice.model.convertservice.ConvertRequest: Returns a token from the conversion request.
getType(String) - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the Type object.
getType(String) - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
getUser() - Method in interface com.onlyoffice.service.documenteditor.config.ConfigService: Returns the User object.
getUser() - Method in class com.onlyoffice.service.documenteditor.config.DefaultConfigService
Goback - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Defines settings for the "Open file location" menu button and upper right corner button.
goback - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines settings for the "Open file location" menu button and upper right corner button.
Goback() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Goback
group - Variable in class com.onlyoffice.model.common.User: Defines the group the user belongs to.

H

handlerClosed(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 4 (CLOSED).
handlerClosed(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
handlerEditing(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 1 (EDITING).
handlerEditing(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
handlerForcesave(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 6 (FORCESAVE).
handlerForcesave(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
handlerForcesaveCurrupted(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 7 (FORCESAVE_CORRUPTED).
handlerForcesaveCurrupted(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
handlerSave(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 2 (SAVE).
handlerSave(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
handlerSaveCorrupted(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the handler that is called if the callback status is 3 (SAVE_CORRUPTED).
handlerSaveCorrupted(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
hasAction(String, String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
hasAction(String, String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Determines whether an action can be performed on a document with a name specified in the request.
header - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
header - Variable in class com.onlyoffice.model.settings.security.Security: Defines the authorization header.
healthCheckUrl - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
height - Variable in class com.onlyoffice.model.convertservice.convertrequest.Thumbnail: Defines the thumbnail height in pixels.
height - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the document height (100% by default) in the browser window.
help - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the "Help" menu button is displayed or hidden.
hideNotes - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the note panel is displayed or hidden on first loading.
hideReviewDisplay - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review: Defines if the "Display mode" button is displayed or hidden on the "Collaboration" tab.
hideRightMenu - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the right menu is displayed or hidden on first loading.
hideRulers - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the editor rulers are displayed or hidden.
History - Class in com.onlyoffice.model.documenteditor.callback: Defines the object with the document changes history.
history - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the object with the document changes history.
History() - Constructor for class com.onlyoffice.model.documenteditor.callback.History
History - Class in com.onlyoffice.model.documenteditor: Defines the document version history.
History() - Constructor for class com.onlyoffice.model.documenteditor.History
history - Variable in class com.onlyoffice.model.documenteditor.History: Defines the array with the document versions.
HistoryData - Class in com.onlyoffice.model.documenteditor: Defines the version history data.
HistoryData() - Constructor for class com.onlyoffice.model.documenteditor.HistoryData
hoverMode - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review: Defines the review display mode: show reviews in tooltips by hovering the changes ("true") or in balloons by clicking the changes ("false").
HTTP_CLIENT_IGNORE_SSL_CERTIFICATE - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the setting to ignore SSL certificate.
httpClient - Variable in class com.onlyoffice.model.properties.DocsIntegrationSdkProperties
HttpClientProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk
HttpClientProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.HttpClientProperties
HttpClientSettings - Class in com.onlyoffice.model.settings
HttpClientSettings() - Constructor for class com.onlyoffice.model.settings.HttpClientSettings

I

id - Variable in class com.onlyoffice.model.common.User: Defines the identification of the user.
id - Variable in enum com.onlyoffice.model.documenteditor.callback.action.Type: Defines the action type ID.
id - Variable in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Defines the ID of the force saving request type.
id - Variable in enum com.onlyoffice.model.documenteditor.callback.Status: Defines the status ID.
ignoreSslCertificate - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.HttpClientProperties
ignoreSSLCertificate - Variable in class com.onlyoffice.model.settings.HttpClientSettings
ignoreSSLCertificate - Variable in class com.onlyoffice.model.settings.Settings: Specifies if the SSL certificate will be ignored or not.
image - Variable in class com.onlyoffice.model.common.User: The path to the user avatar.
image - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo: Defines the path to the image file used to show in the common work mode (i.e.
image - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Template: Defines the absolute URL to the image for template.
imageDark - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo: Defines the path to the image file used for the dark theme.
imageEmbedded - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo: Deprecated.
imageLight - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo: Path to the image file used for the light header (for example, in the Gray theme).
Info - Class in com.onlyoffice.model.documenteditor.config.document: Defines the additional parameters for the document.
info - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the additional parameters for the document.
Info() - Constructor for class com.onlyoffice.model.documenteditor.config.document.Info
info - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines some additional information about the company or person you want the others to know.
init() - Static method in class com.onlyoffice.manager.document.DefaultDocumentManager
init() - Static method in class com.onlyoffice.utils.ConfigurationUtils
INNER_URL - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the internal URL to the Document Server.
innerUrl - Variable in class com.onlyoffice.model.settings.Settings: Defines the internal URL to the Document Server.
insertImage - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.EditingServiceProperties
instanceId - Variable in class com.onlyoffice.model.documenteditor.config.document.ReferenceData: Defines the unique system identifier.
integrationMode - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the mode of embedding editors into the web page.
isDemoActive() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
isDemoActive() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Checks whether the demo editor is active.
isDemoAvailable() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
isDemoAvailable() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Checks whether the demo editor is available.
isEditable(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
isEditable(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Determines whether a document with a name specified in the request is editable.
isFillable(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
isFillable(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Determines whether a document with a name specified in the request is fillable.
isForm(InputStream) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
isForm(InputStream) - Method in interface com.onlyoffice.manager.document.DocumentManager: Determines whether a file is form.
isIgnoreSSLCertificate() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
isIgnoreSSLCertificate() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Checks whether the setting to ignore SSL certificate is enabled.
isInit - Static variable in class com.onlyoffice.utils.ConfigurationUtils: Flag indicating whether settings have been initialized.
isLink - Variable in class com.onlyoffice.model.documenteditor.config.document.info.SharingSettings: Specifies whether to change the user icon to the link icon.
isSecurityEnabled() - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
isSecurityEnabled() - Method in interface com.onlyoffice.manager.settings.SettingsManager: Checks whether JWT validation is enabled.
isViewable(String) - Method in class com.onlyoffice.manager.document.DefaultDocumentManager
isViewable(String) - Method in interface com.onlyoffice.manager.document.DocumentManager: Determines whether a document with a name specified in the request is viewable.

J

jwtManager - Variable in class com.onlyoffice.manager.request.DefaultRequestManager: JwtManager.
JwtManager - Interface in com.onlyoffice.manager.security
jwtManager - Variable in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService: JwtManager.
jwtManager - Variable in class com.onlyoffice.service.documenteditor.config.DefaultConfigService: JwtManager.

K

key - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines the document identifier used to unambiguously identify the document file.
key - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the document identifier used to unambiguously identify the document file.
key - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the document identifier used to unambiguously identify the document file.
key - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the edited document identifier.
key - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the unique document identifier used by the service to recognize the document.
key - Variable in class com.onlyoffice.model.documenteditor.config.document.ReferenceData: defines the unique document identifier used by the service to take the data from the co-editing session.
key - Variable in class com.onlyoffice.model.documenteditor.FormData: The form key.
key - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the unique document identifier used by the service to recognize the document.
key - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the document identifier used to unambiguously identify the document file.
key - Variable in class com.onlyoffice.model.documenteditor.historydata.Previous: Defines the document identifier of the previous version of the document.
key - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
key - Variable in class com.onlyoffice.model.settings.security.Security: Defines the secret authorization key.
keys - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the document identifiers used to unambiguously identify the document file.

L

label - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Anonymous: Defines a postfix added to the user name.
lang - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the editor interface language (if some other languages other than English are present).
leeway - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
license - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the document license information: "end_date" - the license expiration date, "trial" - defines if the license is trial or not, "customization" - defines if the customization parameters marked with the * sign are available for editing only in ONLYOFFICE Developer Edition or not, "connections" - the number of connections for the connection license, "connections_view" - the number of connections for the live viewer, "users_count" - the number of users for the user license, "users_view_count" - the number of users for the live viewer, "users_expire" - the number of days after which the user license expires.
location - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Deprecated.
logo - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the path to the image logo (there are no special recommendations for this file, but it would be better if it was in the ".png" format with transparent background).
Logo - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Changes the image file at the top left corner of the editor header.
logo - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Changes the image file at the top left corner of the editor header.
Logo() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo
logoDark - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the path to the image logo for the dark theme (there are no special recommendations for this file, but it would be better if it was in ".png" format with transparent background).
LOSSY_EDIT - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the setting to edit the specified extensions with the possible loss of information.
lossyEdit - Variable in class com.onlyoffice.model.settings.Settings: Defines a set of extensions that can be edited with the possible loss of information.

M

macros - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if document macros will be automatically run when the editor opens.
MacrosMode - Enum in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Defines the macros run mode when autostart is enabled.
macrosMode - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the macros run mode when autostart is enabled.
MacrosMode() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.MacrosMode
mail - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the email address of the company or person who gives access to the editors or the editor authors.
maxFileSize - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.ConvertServiceProperties
maxFileSize - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.EditingServiceProperties
mentionShare - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the hint that describes the event after mentions in a comment.
message - Variable in class com.onlyoffice.model.settings.validation.ValidationResult: Defines the message.
Meta - Class in com.onlyoffice.model.commandservice.commandrequest: Defines the new meta information of the document.
Meta() - Constructor for class com.onlyoffice.model.commandservice.commandrequest.Meta
meta - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines the new meta information of the document.
mime - Variable in class com.onlyoffice.model.common.Format: Defines a list of MIME types of the current document format.
mobileForceView - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the mobile document editor is opened in the view/edit mode on launch.
mobileUserAgent - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.EditingServiceProperties
mobileUserAgent - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
Mode - Enum in com.onlyoffice.model.documenteditor.config.editorconfig.coediting: Defines the co-editing mode ("fast" or "strict").
mode - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.CoEditing: Defines the co-editing mode ("fast" or "strict").
Mode() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.coediting.Mode
Mode - Enum in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the editor opening mode.
mode - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the editor opening mode.
Mode() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.Mode
modifyContentControl - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the content control settings can be changed.
modifyFilter - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the filter can applied globally ("true") affecting all the other users, or locally ("false"), i.e.

N

name - Variable in class com.onlyoffice.model.common.Format: Defines the document format name.
name - Variable in class com.onlyoffice.model.common.User: Defines the full name of the user.
name - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the name of the company or person who gives access to the editors or the editor authors.
name - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.ProductProperties

O

objectMapper - Variable in class com.onlyoffice.manager.request.DefaultRequestManager: ObjectMapper.
objectMapper - Variable in class com.onlyoffice.manager.security.DefaultJwtManager: ObjectMapper.
objectMapper - Variable in class com.onlyoffice.service.command.DefaultCommandService: ObjectMapper.
objectMapper - Variable in class com.onlyoffice.service.convert.DefaultConvertService: ObjectMapper.
objectMapper - Variable in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService: ObjectMapper.
objectMapper - Variable in class com.onlyoffice.service.settings.DefaultSettingsValidationService: ObjectMapper.
outputtype - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the resulting converted document type.
owner - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Defines the name of the document owner/creator.

P

password - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the password for the document file if it is protected with a password.
PDF - Class in com.onlyoffice.model.convertservice.convertrequest
PDF() - Constructor for class com.onlyoffice.model.convertservice.convertrequest.PDF
pdf - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines settings for converting document files to pdf.
percent - Variable in class com.onlyoffice.model.convertservice.ConvertResponse: Defines the percentage of the file conversion.
Permissions - Enum in com.onlyoffice.model.documenteditor.config.document.info.sharingsettings: Defines the access rights for the user with the name above.
permissions - Variable in class com.onlyoffice.model.documenteditor.config.document.info.SharingSettings: Defines the access rights for the user with the name above.
Permissions() - Constructor for enum com.onlyoffice.model.documenteditor.config.document.info.sharingsettings.Permissions
Permissions - Class in com.onlyoffice.model.documenteditor.config.document: Defines the permission for the document to be edited and downloaded or not.
permissions - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the permission for the document to be edited and downloaded or not.
Permissions() - Constructor for class com.onlyoffice.model.documenteditor.config.document.Permissions
phone - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the phone of the company or person who gives access to the editors or the editor authors.
plugins - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if plugins will be launched and available.
Plugins - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the parameters to connect the special add-ons to your Document Server installation which will help you add additional features to document editors.
plugins - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the parameters to connect the special add-ons to your Document Server installation which will help you add additional features to document editors.
Plugins() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.Plugins
pluginsData - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Plugins: Defines an array of absolute URLs to the plugin configuration files ("config.json").
prefix - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
prefix - Variable in class com.onlyoffice.model.settings.security.Security: Defines the authorization prefix.
Previous - Class in com.onlyoffice.model.documenteditor.historydata: Defines the object of the previous version of the document if changesurl address was returned after saving the document.
previous - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the object of the previous version of the document if changesurl address was returned after saving the document.
Previous() - Constructor for class com.onlyoffice.model.documenteditor.historydata.Previous
print - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the document can be printed or not.
processCallback(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Starts the callback handler.
processCallback(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
processCommand(CommandRequest, String) - Method in interface com.onlyoffice.service.command.CommandService: Process command request.
processCommand(CommandRequest, String) - Method in class com.onlyoffice.service.command.DefaultCommandService
processConvert(ConvertRequest, String) - Method in interface com.onlyoffice.service.convert.ConvertService: Starts the file conversion process.
processConvert(ConvertRequest, String) - Method in class com.onlyoffice.service.convert.DefaultConvertService
product - Variable in class com.onlyoffice.model.properties.DocsIntegrationSdkProperties
PRODUCT_INNER_URL - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the internal URL to the product.
productInnerUrl - Variable in class com.onlyoffice.model.settings.Settings: Defines the internal URL to the product.
ProductProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk
ProductProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.ProductProperties
PROPERTIES_PREFIX - Static variable in class com.onlyoffice.utils.ConfigurationUtils: The properties prefix.
protect - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the "Protection" tab on the toolbar and the "Protect" button in the left menu are displayed ("true") or hidden ("false").

Q

quota - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the user quota value: "users" - the user quota for the user license where "userid" - the id of the user who opened the editor, "expire" - date of license expiration for this user; "users_view" - the user quota for the live viewer where "userid" - the id of the user who opened the editor, "expire" - date of viewing expiration for this user.

R

Recent - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the presence or absence of the documents in the "Open Recent..." menu option.
recent - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the presence or absence of the documents in the "Open Recent..." menu option.
Recent() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.Recent
ReferenceData - Class in com.onlyoffice.model.documenteditor.config.document: Defines an object that is generated by the integrator to uniquely identify a file in its system.
referenceData - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines an object that is generated by the integrator to uniquely identify a file in its system.
ReferenceData() - Constructor for class com.onlyoffice.model.documenteditor.config.document.ReferenceData
region - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the default display format for currency and date and time when converting from "Spreadsheet format" to "pdf".
region - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the default display format for currency and date and time (in the "Spreadsheet Editor" only).
remove - Variable in class com.onlyoffice.model.documenteditor.config.document.permissions.CommentGroups: Defines a list of groups whose comments the user can remove.
rename - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Deprecated.
replaceToDocumentServerUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
replaceToDocumentServerUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Replaces the internal URL from the Document Server with the Document Server URL.
replaceToInnerDocumentServerUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
replaceToInnerDocumentServerUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Replaces the URL to the Document Server with the internal one.
request - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Anonymous: Defines if the request is sent or not.
requestClose - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Goback: Deprecated.
RequestedService - Interface in com.onlyoffice.model.common: Defines the requested service parameters.
RequestEntity - Interface in com.onlyoffice.model.common: Defines the requested entity parameters.
RequestManager - Interface in com.onlyoffice.manager.request
requestManager - Variable in class com.onlyoffice.service.command.DefaultCommandService: RequestManager.
requestManager - Variable in class com.onlyoffice.service.convert.DefaultConvertService: RequestManager.
requestManager - Variable in class com.onlyoffice.service.settings.DefaultSettingsValidationService: RequestManager.
RequestManager.Callback<Result> - Interface in com.onlyoffice.manager.request
review - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines if the document can be reviewed or not.
Review - Class in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Contains the information about the review mode.
review - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Contains the information about the review mode.
Review() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review
ReviewDisplay - Enum in com.onlyoffice.model.documenteditor.config.editorconfig.customization.review: Defines the review editing mode which will be used when the document is opened for viewing.
reviewDisplay - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review: Defines the review editing mode which will be used when the document is opened for viewing.
ReviewDisplay() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.review.ReviewDisplay
reviewDisplay - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
reviewGroups - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines the groups whose changes the user can accept/reject.
roles - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Features: defines if the role settings will be disabled in the pdf forms or not.

S

sanitizeUrl(String) - Method in class com.onlyoffice.manager.url.DefaultUrlManager
sanitizeUrl(String) - Method in interface com.onlyoffice.manager.url.UrlManager: Removes the trailing slash from the URL if it exists.
saveUrl - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded: Defines the absolute URL that will allow the document to be saved onto the user personal computer.
security - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
Security - Class in com.onlyoffice.model.settings.security: Defines the security parameters.
Security() - Constructor for class com.onlyoffice.model.settings.security.Security
security - Variable in class com.onlyoffice.model.settings.Settings: Defines the security parameters.
SECURITY_HEADER - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the authorization header.
SECURITY_KEY - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the secret authorization key.
SECURITY_PREFIX - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the authorization prefix.
SecurityProperties - Class in com.onlyoffice.model.properties.docsintegrationsdk.documentserver
SecurityProperties() - Constructor for class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
server - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the server characteristics: "resultType" - the license status (1 - an error occurred, 2 - the license expired, 3 - the license is still available, 6 - the trial license expired), "packageType" - the product version (0 - an open source product, 1 - the Enterprise Edition, 2 - the Developer Edition), "buildDate" - the build date, "buildVersion" - the build version, "buildNumber" - the build number.
serverVersion - Variable in class com.onlyoffice.model.documenteditor.callback.History: Defines the current server version number.
serverVersion - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the current server version number.
setSetting(String, String) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
setSetting(String, String) - Method in interface com.onlyoffice.manager.settings.SettingsManager: Sets a value for the setting with the name specified in the request.
setSettings(Settings) - Method in class com.onlyoffice.manager.settings.DefaultSettingsManager
setSettings(Settings) - Method in interface com.onlyoffice.manager.settings.SettingsManager: Sets the settings specified with the "Settings" object.
Settings - Class in com.onlyoffice.model.settings: Defines the Document Server settings.
Settings() - Constructor for class com.onlyoffice.model.settings.Settings
SettingsConstants - Class in com.onlyoffice.model.settings: Defines the settings constants.
SettingsConstants() - Constructor for class com.onlyoffice.model.settings.SettingsConstants
settingsManager - Variable in class com.onlyoffice.manager.document.DefaultDocumentManager: SettingsManager.
settingsManager - Variable in class com.onlyoffice.manager.request.DefaultRequestManager: SettingsManager.
settingsManager - Variable in class com.onlyoffice.manager.security.DefaultJwtManager: SettingsManager.
SettingsManager - Interface in com.onlyoffice.manager.settings
settingsManager - Variable in class com.onlyoffice.manager.url.DefaultUrlManager: SettingsManager.
settingsManager - Variable in class com.onlyoffice.service.convert.DefaultConvertService: SettingsManager.
settingsManager - Variable in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService: SettingsManager.
settingsManager - Variable in class com.onlyoffice.service.documenteditor.config.DefaultConfigService: SettingsManager.
settingsManager - Variable in class com.onlyoffice.service.settings.DefaultSettingsValidationService: SettingsManager.
SettingsValidationService - Interface in com.onlyoffice.service.settings
setToken(String) - Method in class com.onlyoffice.model.commandservice.CommandRequest: Adds a token to the command request.
setToken(String) - Method in interface com.onlyoffice.model.common.RequestEntity: Adds a token to the request.
setToken(String) - Method in class com.onlyoffice.model.convertservice.ConvertRequest: Adds a token to the conversion request.
shareUrl - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded: Defines the absolute URL that will allow other users to share this document.
SharingSettings - Class in com.onlyoffice.model.documenteditor.config.document.info: Defines the information about the settings which allow to share the document with other users.
SharingSettings() - Constructor for class com.onlyoffice.model.documenteditor.config.document.info.SharingSettings
sharingSettings - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Defines the information about the settings which allow to share the document with other users.
showReviewChanges - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review: Defines if the review changes panel is automatically displayed or hidden when the editor is loaded.
showReviewChanges - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
socketTimeout - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.HttpClientProperties
socketTimeout - Variable in class com.onlyoffice.model.settings.HttpClientSettings
spellcheck - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Features: Defines if the spell checker is automatically switched on or off when the editor is loaded.
spellcheck - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
Status - Enum in com.onlyoffice.model.documenteditor.callback: Defines the status of the document.
status - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the status of the document.
Status() - Constructor for enum com.onlyoffice.model.documenteditor.callback.Status
Status - Enum in com.onlyoffice.model.settings.validation.status: Defines the validation result status.
Status() - Constructor for enum com.onlyoffice.model.settings.validation.status.Status
status - Variable in class com.onlyoffice.model.settings.validation.ValidationResult: Defines the validation result status.
submitForm - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the Submit button is displayed or hidden on the top toolbar.
syncSocketTimeout - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.ConvertServiceProperties

T

tabBackground - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Features: Defines the background of the top toolbar tabs.
tabStyle - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Features: Defines the style of the top toolbar tabs.
tag - Variable in class com.onlyoffice.model.documenteditor.FormData: The form tag.
Template - Class in com.onlyoffice.model.documenteditor.config.editorconfig: Defines the presence or absence of the templates in the "Create New..." menu option.
Template() - Constructor for class com.onlyoffice.model.documenteditor.config.editorconfig.Template
templates - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the presence or absence of the templates in the "Create New..." menu option.
text - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Close: defines the tooltip text for a button in the editor header or the menu item text in the mobile editors and in the File menu of the web editors.
text - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Goback: Defines the text which will be displayed for the "Open file location" menu button and upper right corner button (i.e.
Thumbnail - Class in com.onlyoffice.model.convertservice.convertrequest
Thumbnail() - Constructor for class com.onlyoffice.model.convertservice.convertrequest.Thumbnail
thumbnail - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the settings for the thumbnail when specifying the image formats ("bmp", "gif", "jpg", "png") as "outputtype".
title - Variable in class com.onlyoffice.model.commandservice.commandrequest.Meta: Defines the new document name.
title - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the converted file name.
title - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the desired file name for the viewed or edited document which will also be used as file name when the document is downloaded.
title - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Recent: Defines the document title that will be displayed in the "Open Recent..." menu option.
title - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Template: Defines the template title that will be displayed in the "Create New..." menu option.
token - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines the encrypted signature added to the Document Server config in the form of a token.
token - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the encrypted signature added to the Document Server config in the form of a token.
token - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the encrypted signature in the form of a token.
token - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the encrypted signature added to the Document Server config in the form of a token.
token - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the encrypted signature added to the parameter in the form of a token.
tokenValidityInMinutes - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.SecurityProperties
Toolbar - Enum in com.onlyoffice.model.documenteditor.config.editorconfig.embedded: Defines the place for the embedded viewer toolbar, can be either "top" or "bottom".
Toolbar() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.embedded.Toolbar
toolbarDocked - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Embedded: Defines the place for the embedded viewer toolbar, can be either "top" or "bottom".
toolbarHideFileName - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines if the document title is visible on the top toolbar ("false") or hidden ("true").
toolbarNoTabs - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
trackChanges - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Review: Defines if the document is opened in the review editing mode ("true") or not ("false") regardless of the document.permissions.review parameter (the review mode is changed only for the current user).
trackChanges - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Deprecated.
type - Variable in class com.onlyoffice.model.common.Format: Defines the document format type.
Type - Enum in com.onlyoffice.model.documenteditor.callback.action: Defines the action type.
type - Variable in class com.onlyoffice.model.documenteditor.callback.Action: Defines the action type.
Type() - Constructor for enum com.onlyoffice.model.documenteditor.callback.action.Type
Type - Enum in com.onlyoffice.model.documenteditor.config.document: Defines the platform type used to access the document.
Type() - Constructor for enum com.onlyoffice.model.documenteditor.config.document.Type
type - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the platform type used to access the document.
type - Variable in class com.onlyoffice.model.documenteditor.FormData: The form type.

U

uiTheme - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the editor theme settings.
Unit - Enum in com.onlyoffice.model.documenteditor.config.editorconfig.customization: Defines the measurement units used on the ruler and in dialog boxes.
unit - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the measurement units used on the ruler and in dialog boxes.
Unit() - Constructor for enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.Unit
uploaded - Variable in class com.onlyoffice.model.documenteditor.config.document.Info: Defines the document uploading date.
url - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the link to the edited document to be saved with the document storage service.
url - Variable in class com.onlyoffice.model.convertservice.ConvertRequest: Defines the absolute URL to the document to be converted.
url - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines the link to the edited document to be saved with the document storage service.
url - Variable in class com.onlyoffice.model.documenteditor.config.Document: Defines the absolute URL where the source viewed or edited document is stored.
url - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Goback: Defines the absolute URL to the website address which will be opened when clicking the "Open file location" menu button.
url - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Logo: Defines the absolute URL which will be used when someone clicks the logo image (can be used to go to your web site, etc.).
url - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Recent: Defines the absolute URL to the document where it is stored.
url - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Template: Defines the absolute URL to the document where it will be created and available after creation.
url - Variable in class com.onlyoffice.model.documenteditor.historydata.Previous: Defines the url address of the previous version of the document.
url - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the url address of the current document version.
url - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.CommandServiceProperties
url - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.ConvertServiceProperties
url - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.documentserver.DocbuilderServiceProperties
url - Variable in class com.onlyoffice.model.properties.docsintegrationsdk.DocumentServerProperties
url - Variable in class com.onlyoffice.model.settings.Settings: Defines the URL to the Document Server.
URL - Static variable in class com.onlyoffice.model.settings.SettingsConstants: Defines the URL to the Document Server.
urlManager - Variable in class com.onlyoffice.manager.request.DefaultRequestManager: UrlManager.
UrlManager - Interface in com.onlyoffice.manager.url
urlManager - Variable in class com.onlyoffice.service.convert.DefaultConvertService: UrlManager.
urlManager - Variable in class com.onlyoffice.service.documenteditor.config.DefaultConfigService: UrlManager.
urlManager - Variable in class com.onlyoffice.service.settings.DefaultSettingsValidationService: UrlManager.
User - Class in com.onlyoffice.model.common: Defines the user currently viewing or editing the document.
User() - Constructor for class com.onlyoffice.model.common.User
user - Variable in class com.onlyoffice.model.documenteditor.config.document.info.SharingSettings: Defines the name of the user the document will be shared with.
user - Variable in class com.onlyoffice.model.documenteditor.config.EditorConfig: Defines the user currently viewing or editing the document.
user - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the user who is the author of the document version.
userdata - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines some custom identifier which will help distinguish the specific request in case there were more than one.
userid - Variable in class com.onlyoffice.model.documenteditor.callback.Action: Defines the user identifier.
userInfoGroups - Variable in class com.onlyoffice.model.documenteditor.config.document.Permissions: Defines the groups of users whose information is displayed in the editors: 1) the usernames are displayed in the list of the editing users in the editor header, 2) when typing text, the user cursors and tooltips with their names are displayed, 3) when locking objects in the strict co-editing mode, the usernames are displayed.
users - Variable in class com.onlyoffice.model.commandservice.CommandRequest: Defines the list of the user identifiers.
users - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the list of the identifiers of the users who opened the document for editing.
users - Variable in class com.onlyoffice.model.documenteditor.Callback: Defines a list of the identifiers of the users who opened the document for editing.

V

ValidationResult - Class in com.onlyoffice.model.settings.validation: Defines the validation result properties.
ValidationResult() - Constructor for class com.onlyoffice.model.settings.validation.ValidationResult
value - Variable in class com.onlyoffice.model.documenteditor.FormData: The current form value.
valueOf(String) - Static method in enum com.onlyoffice.model.commandservice.commandrequest.Command: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.common.CommonResponse.Error: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.callback.action.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.callback.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.document.DocumentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.document.info.sharingsettings.Permissions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.document.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.coediting.Mode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.MacrosMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.review.ReviewDisplay: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.Unit: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.embedded.Toolbar: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.Mode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.documenteditor.formdata.FormSpecificType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.onlyoffice.model.settings.validation.status.Status: Returns the enum constant of this type with the specified name.
valueOfCode(Integer) - Static method in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Returns the enum constant of this type with the specified code.
valueOfCode(Integer) - Static method in enum com.onlyoffice.model.common.CommonResponse.Error: Returns the enum constant of this type with the specified code.
valueOfCode(Integer) - Static method in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Returns the enum constant of this type with the specified code.
valueOfId(Integer) - Static method in enum com.onlyoffice.model.documenteditor.callback.action.Type: Returns the enum constant of this type with the specified ID.
valueOfId(Integer) - Static method in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Returns the enum constant of this type with the specified ID.
valueOfId(Integer) - Static method in enum com.onlyoffice.model.documenteditor.callback.Status: Returns the enum constant of this type with the specified ID.
values() - Static method in enum com.onlyoffice.model.commandservice.commandrequest.Command: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.commandservice.CommandResponse.Error: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.common.CommonResponse.Error: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.convertservice.ConvertResponse.Error: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.callback.action.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.callback.ForcesaveType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.callback.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.document.DocumentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.document.info.sharingsettings.Permissions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.document.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.coediting.Mode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.MacrosMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.review.ReviewDisplay: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.customization.Unit: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.embedded.Toolbar: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.config.editorconfig.Mode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.documenteditor.formdata.FormSpecificType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.onlyoffice.model.settings.validation.status.Status: Returns an array containing the constants of this enum type, in the order they are declared.
verify(String) - Method in class com.onlyoffice.manager.security.DefaultJwtManager
verify(String) - Method in interface com.onlyoffice.manager.security.JwtManager: Performs the verification against the given token using the key from SettingsManager.
verifyCallback(Callback, String) - Method in interface com.onlyoffice.service.documenteditor.callback.CallbackService: Verifies the Callback object.
verifyCallback(Callback, String) - Method in class com.onlyoffice.service.documenteditor.callback.DefaultCallbackService
verifyToken(String, String) - Method in class com.onlyoffice.manager.security.DefaultJwtManager
verifyToken(String, String) - Method in interface com.onlyoffice.manager.security.JwtManager: Performs the verification against the given token using the key passed as a method parameter.
version - Variable in class com.onlyoffice.model.commandservice.CommandResponse: Defines the document version.
Version - Class in com.onlyoffice.model.documenteditor.history: Defines the array with the document versions.
Version() - Constructor for class com.onlyoffice.model.documenteditor.history.Version
version - Variable in class com.onlyoffice.model.documenteditor.history.Version: Defines the document version number.
version - Variable in class com.onlyoffice.model.documenteditor.HistoryData: Defines the document version number.
view - Variable in class com.onlyoffice.model.documenteditor.config.document.permissions.CommentGroups: Defines a list of groups whose comments the user can view.
visible - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Close: Defines if the cross button to close the editor is displayed or hidden.

W

width - Variable in class com.onlyoffice.model.convertservice.convertrequest.Thumbnail: Defines the thumbnail width in pixels.
width - Variable in class com.onlyoffice.model.documenteditor.Config: Defines the document width (100% by default) in the browser window.
www - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.customization.Customer: Defines the home website address of the above company or person.

Z

zoom - Variable in class com.onlyoffice.model.documenteditor.config.editorconfig.Customization: Defines the document display zoom value measured in percent.

A B C D E F G H I J K L M N O P Q R S T U V W Z