Config.Builder (eXo OnlyOffice Editor :: Extension Services 1.4.2 API)

java.lang.Object
- org.exoplatform.onlyoffice.Config.Builder

Enclosing class:: Config

public static class Config.Builder
extends Object

The Class Builder.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`author` The folder.
`protected String`	`callbackUrl` The editor.
`protected String`	`comment` The comment.
`protected String`	`created` The folder.
`protected String`	`displayPath` The display path.
`protected String`	`docId` The document ID in storage.
`protected String`	`documentserverSecret` The document server secret key.
`protected String`	`documentserverUrl` The documentserver url.
`protected String`	`documentType` The document type.
`protected String`	`editorUrl` The editor page at platform URL.
`protected URI`	`explorerUri` The ECMS explorer page URL.
`protected String`	`explorerUrl` Deprecated.
`protected String`	`fileType` The document.
`protected String`	`firstname` The user.
`protected String`	`folder` The folder.
`protected Boolean`	`isActivity` The indicator to show if the document has a file activity
`protected String`	`key` The document.
`protected String`	`lang` The editor.
`protected Long`	`lastModified` The lastModified.
`protected String`	`lastModifier` The last modifier.
`protected String`	`lastname` The user.
`protected String`	`mode` The editor.
`protected String`	`path` The path.
`protected String`	`platformRestUrl` The platform REST URL base.
`protected String`	`title` The document.
`protected String`	`url` The document.
`protected String`	`userId` The user.
`protected String`	`workspace` The workspace of the storage.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Builder(String documentserverUrl, String documentType, String workspace, String path, String docId)` Instantiates a new builder.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Config.Builder`	`author(String author)` Author.
`Config`	`build()` Builds the.
`Config.Builder`	`callbackUrl(String callbackUrl)` Callback url.
`Config.Builder`	`comment(String comment)` Display path.
`Config.Builder`	`created(Calendar createdTime)` Created.
`Config.Builder`	`displayPath(String displayPath)` Display path.
`Config.Builder`	`editorUrl(String editorUrl)` Editor page URL.
`Config.Builder`	`explorerUri(URI uri)` URI of ECMS explorer page with a document.
`Config.Builder`	`explorerUrl(String explorerUrl)` Deprecated.
`Config.Builder`	`fileType(String fileType)` File type.
`Config.Builder`	`folder(String folder)` Folder.
`Config.Builder`	`generateUrls(String platformRestUrl)` Generate file and callback URLs using given Platform base URL.
`Config.Builder`	`isActivity(Boolean isActivity)` IsActivity.
`Config.Builder`	`key(String key)` Key.
`Config.Builder`	`lang(String lang)` Lang.
`Config.Builder`	`lastModified(Long lastModified)` Sets last modified.
`Config.Builder`	`lastModifier(String lastModifier)` Sets last modifier.
`Config.Builder`	`mode(String mode)` Mode.
`Config.Builder`	`secret(String documentServerSecret)` Secret
`Config.Builder`	`title(String title)` Title.
`Config.Builder`	`url(String url)` Url.
`Config.Builder`	`userFirstName(String firstname)` User first name.
`Config.Builder`	`userId(String userId)` User id.
`Config.Builder`	`userLastName(String lastname)` User last name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - docId
```
protected final String docId
```
    The document ID in storage.
  - workspace
```
protected final String workspace
```
    The workspace of the storage.
  - path
```
protected final String path
```
    The path.
  - documentType
```
protected final String documentType
```
    The document type.
  - documentserverUrl
```
protected final String documentserverUrl
```
    The documentserver url.
  - platformRestUrl
```
protected String platformRestUrl
```
    The platform REST URL base.
  - editorUrl
```
protected String editorUrl
```
    The editor page at platform URL.
  - documentserverSecret
```
protected String documentserverSecret
```
    The document server secret key.
  - lastModifier
```
protected String lastModifier
```
    The last modifier.
  - lastModified
```
protected Long lastModified
```
    The lastModified.
  - explorerUrl
```
@Deprecated
protected String explorerUrl
```
    Deprecated.
    
    The ECMS explorer page URL.
  - displayPath
```
protected String displayPath
```
    The display path.
  - comment
```
protected String comment
```
    The comment.
  - isActivity
```
protected Boolean isActivity
```
    The indicator to show if the document has a file activity
  - explorerUri
```
protected URI explorerUri
```
    The ECMS explorer page URL.
  - fileType
```
protected String fileType
```
    The document.
  - key
```
protected String key
```
    The document.
  - title
```
protected String title
```
    The document.
  - url
```
protected String url
```
    The document.
  - author
```
protected String author
```
    The folder.
  - created
```
protected String created
```
    The folder.
  - folder
```
protected String folder
```
    The folder.
  - callbackUrl
```
protected String callbackUrl
```
    The editor.
  - lang
```
protected String lang
```
    The editor.
  - mode
```
protected String mode
```
    The editor.
  - userId
```
protected String userId
```
    The user.
  - firstname
```
protected String firstname
```
    The user.
  - lastname
```
protected String lastname
```
    The user.
- Constructor Detail
  - Builder
```
protected Builder(String documentserverUrl,
                  String documentType,
                  String workspace,
                  String path,
                  String docId)
```
    Instantiates a new builder.
    
    Parameters:
    
    documentserverUrl - the document server URL
    
    documentType - the document type
    
    workspace - the workspace
    
    path - the path
    
    docId - the doc id
- Method Detail
  - generateUrls
```
public Config.Builder generateUrls(String platformRestUrl)
```
    Generate file and callback URLs using given Platform base URL. This will erase these URLs explicitly set previously.
    
    Parameters:
    
    platformRestUrl - the platform URL
    
    Returns:
    
    the builder
  - editorUrl
```
public Config.Builder editorUrl(String editorUrl)
```
    Editor page URL.
    
    Parameters:
    
    editorUrl - the editor url
    
    Returns:
    
    the builder
  - explorerUrl
```
@Deprecated
public Config.Builder explorerUrl(String explorerUrl)
```
    Deprecated.
    
    Explorer url.
    
    Parameters:
    
    explorerUrl - the explorer url
    
    Returns:
    
    the builder
  - explorerUri
```
public Config.Builder explorerUri(URI uri)
```
    URI of ECMS explorer page with a document.
    
    Parameters:
    
    uri - the URI of the page
    
    Returns:
    
    the builder
  - title
```
public Config.Builder title(String title)
```
    Title.
    
    Parameters:
    
    title - the title
    
    Returns:
    
    the builder
  - key
```
public Config.Builder key(String key)
```
    Key.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the builder
  - fileType
```
public Config.Builder fileType(String fileType)
```
    File type.
    
    Parameters:
    
    fileType - the file type
    
    Returns:
    
    the builder
  - url
```
public Config.Builder url(String url)
```
    Url.
    
    Parameters:
    
    url - the url
    
    Returns:
    
    the builder
  - author
```
public Config.Builder author(String author)
```
    Author.
    
    Parameters:
    
    author - the author
    
    Returns:
    
    the builder
  - created
```
public Config.Builder created(Calendar createdTime)
```
    Created.
    
    Parameters:
    
    createdTime - the created time
    
    Returns:
    
    the builder
  - displayPath
```
public Config.Builder displayPath(String displayPath)
```
    Display path.
    
    Parameters:
    
    displayPath - the created displayPath
    
    Returns:
    
    the builder
  - comment
```
public Config.Builder comment(String comment)
```
    Display path.
    
    Parameters:
    
    comment - the created comment
    
    Returns:
    
    the builder
  - isActivity
```
public Config.Builder isActivity(Boolean isActivity)
```
    IsActivity.
    
    Parameters:
    
    isActivity - the has isActivity
    
    Returns:
    
    the builder
  - folder
```
public Config.Builder folder(String folder)
```
    Folder.
    
    Parameters:
    
    folder - the folder
    
    Returns:
    
    the builder
  - callbackUrl
```
public Config.Builder callbackUrl(String callbackUrl)
```
    Callback url.
    
    Parameters:
    
    callbackUrl - the callback url
    
    Returns:
    
    the builder
  - lang
```
public Config.Builder lang(String lang)
```
    Lang.
    
    Parameters:
    
    lang - the lang
    
    Returns:
    
    the builder
  - mode
```
public Config.Builder mode(String mode)
```
    Mode.
    
    Parameters:
    
    mode - the mode
    
    Returns:
    
    the builder
  - userId
```
public Config.Builder userId(String userId)
```
    User id.
    
    Parameters:
    
    userId - the user id
    
    Returns:
    
    the builder
  - userFirstName
```
public Config.Builder userFirstName(String firstname)
```
    User first name.
    
    Parameters:
    
    firstname - the firstname
    
    Returns:
    
    the builder
  - userLastName
```
public Config.Builder userLastName(String lastname)
```
    User last name.
    
    Parameters:
    
    lastname - the lastname
    
    Returns:
    
    the builder
  - secret
```
public Config.Builder secret(String documentServerSecret)
```
    Secret
    
    Parameters:
    
    documentServerSecret - the document server secret
    
    Returns:
    
    the builder
  - lastModifier
```
public Config.Builder lastModifier(String lastModifier)
```
    Sets last modifier.
    
    Parameters:
    
    lastModifier - the last Modifier
    
    Returns:
    
    the builder
  - lastModified
```
public Config.Builder lastModified(Long lastModified)
```
    Sets last modified.
    
    Parameters:
    
    lastModified - the last modified
    
    Returns:
    
    the builder
  - build
```
public Config build()
```
    Builds the.
    
    Returns:
    
    the config

Class Config.Builder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

docId

workspace

path

documentType

documentserverUrl

platformRestUrl

editorUrl

documentserverSecret

lastModifier

lastModified

explorerUrl

displayPath

comment

isActivity

explorerUri

fileType

key

title

url

author

created

folder

callbackUrl

lang

mode

userId

firstname

lastname

Constructor Detail

Builder

Method Detail

generateUrls

editorUrl

explorerUrl

explorerUri

title

key

fileType

url

author

created

displayPath

comment

isActivity

folder

callbackUrl

lang

mode

userId

userFirstName

userLastName

secret

lastModifier

lastModified

build