com.onlyoffice.service.documenteditor.config

Interface ConfigService

All Known Implementing Classes:

DefaultConfigService

public interface ConfigService

Method Summary

Modifier and Type	Method and Description
Config	createConfig(String fileId, Mode mode, String userAgent) Creates a configuration for the document editor using the User-Agent request header.
Config	createConfig(String fileId, Mode mode, Type type) Creates a configuration for the document editor using the Type parameter.
CoEditing	getCoEditing(String fileId, Mode mode, Type type) Returns the CoEditing object.
Customization	getCustomization(String fileId) Returns the Customization object.
Document	getDocument(String fileId, Type type) Returns the Document object.
EditorConfig	getEditorConfig(String fileId, Mode mode, Type type) Returns the EditorConfig object.
Embedded	getEmbedded(String fileId) Returns the Embedded object.
Info	getInfo(String fileId) Returns the Info object.
Permissions	getPermissions(String fileId) Returns the Permissions object.
Plugins	getPlugins(Object object) Returns the Plugins object.
List<Recent>	getRecent(Object object) Returns a list of the Recent objects.
ReferenceData	getReferenceData(String fileId) Returns the ReferenceData object.
List<Template>	getTemplates(String fileId) Returns a list of the Template objects.
Type	getType(String userAgent) Returns the Type object.
User	getUser() Returns the User object.

Method Detail

createConfig

Config createConfig(String fileId,
                    Mode mode,
                    String userAgent)

Creates a configuration for the document editor using the User-Agent request header.

Parameters:

fileId - The file ID.

mode - The editor opening mode.

userAgent - The User-Agent request header that is used to determine the platform type ("desktop" or "mobile").

Returns:

The Config object.

createConfig

Config createConfig(String fileId,
                    Mode mode,
                    Type type)

Creates a configuration for the document editor using the Type parameter.

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The Config object.

getDocument

Document getDocument(String fileId,
                     Type type)

Returns the Document object.

Parameters:

fileId - The file ID.

type - The platform type used to access the document.

Returns:

The ReferenceData object.

getEditorConfig

EditorConfig getEditorConfig(String fileId,
                             Mode mode,
                             Type type)

Returns the EditorConfig object.

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The EditorConfig object.

getReferenceData

ReferenceData getReferenceData(String fileId)

Returns the ReferenceData object.

Parameters:

fileId - The file ID.

Returns:

The ReferenceData object.

getInfo

Info getInfo(String fileId)

Returns the Info object.

Parameters:

fileId - The file ID.

Returns:

The Info object.

getPermissions

Permissions getPermissions(String fileId)

Returns the Permissions object.

Parameters:

fileId - The file ID.

Returns:

The Permissions object.

getCoEditing

CoEditing getCoEditing(String fileId,
                       Mode mode,
                       Type type)

Returns the CoEditing object.

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The CoEditing object.

getRecent

List<Recent> getRecent(Object object)

Returns a list of the Recent objects.

Parameters:

object - The object.

Returns:

A list of the Recent objects.

getTemplates

List<Template> getTemplates(String fileId)

Returns a list of the Template objects.

Parameters:

fileId - The file ID.

Returns:

A list of the Template objects.

getUser

User getUser()

Returns the User object.

Returns:

The User object.

getCustomization

Customization getCustomization(String fileId)

Returns the Customization object.

Parameters:

fileId - The file ID.

Returns:

The Customization object.

getEmbedded

Embedded getEmbedded(String fileId)

Returns the Embedded object.

Parameters:

fileId - The file ID.

Returns:

The Embedded object.

getPlugins

Plugins getPlugins(Object object)

Returns the Plugins object.

Parameters:

object - The object.

Returns:

The Plugins object.

getType

Type getType(String userAgent)

Returns the Type object.

Parameters:

userAgent - The User-Agent request header that is used to determine the platform type ("desktop" or "mobile").

Returns:

The Type object.