程序包 com.onlyoffice.service.documenteditor.config

接口 ConfigService

所有已知实现类:
DefaultConfigService
public interface ConfigService

  • 方法详细资料

    • createConfig

      Config createConfig(String bucket, String fileId, Mode mode, String userAgent)
      Creates a configuration for the document editor using the User-Agent request header.
      参数:
      bucket - The file bucket.
      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").
      返回:
      The Config object.

    • createConfig

      Config createConfig(String bucket, String fileId, Mode mode, Type type)
      Creates a configuration for the document editor using the Type parameter.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      mode - The editor opening mode.
      type - The platform type used to access the document.
      返回:
      The Config object.

    • getDocument

      Document getDocument(String bucket, String fileId, Type type)
      Returns the Document object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      type - The platform type used to access the document.
      返回:
      The ReferenceData object.

    • getEditorConfig

      EditorConfig getEditorConfig(String bucket, String fileId, Mode mode, Type type)
      Returns the EditorConfig object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      mode - The editor opening mode.
      type - The platform type used to access the document.
      返回:
      The EditorConfig object.

    • getReferenceData

      ReferenceData getReferenceData(String bucket, String fileId)
      Returns the ReferenceData object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      The ReferenceData object.

    • getInfo

      Info getInfo(String bucket, String fileId)
      Returns the Info object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      The Info object.

    • getPermissions

      Permissions getPermissions(String bucket, String fileId)
      Returns the Permissions object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      The Permissions object.

    • getCoEditing

      CoEditing getCoEditing(String bucket, String fileId, Mode mode, Type type)
      Returns the CoEditing object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      mode - The editor opening mode.
      type - The platform type used to access the document.
      返回:
      The CoEditing object.

    • getRecent

      List<Recent> getRecent(Object object)
      Returns a list of the Recent objects.
      参数:
      object - The object.
      返回:
      A list of the Recent objects.

    • getTemplates

      List<Template> getTemplates(String bucket, String fileId)
      Returns a list of the Template objects.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      A list of the Template objects.

    • getUser

      User getUser()
      Returns the User object.
      返回:
      The User object.

    • getCustomization

      Customization getCustomization(String bucket, String fileId)
      Returns the Customization object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      The Customization object.

    • getEmbedded

      Embedded getEmbedded(String bucket, String fileId)
      Returns the Embedded object.
      参数:
      bucket - The file bucket.
      fileId - The file ID.
      返回:
      The Embedded object.

    • getPlugins

      Plugins getPlugins(Object object)
      Returns the Plugins object.
      参数:
      object - The object.
      返回:
      The Plugins object.

    • getType

      Type getType(String userAgent)
      Returns the Type object.
      参数:
      userAgent - The User-Agent request header that is used to determine the platform type ("desktop" or "mobile").
      返回:
      The Type object.