com.onlyoffice.model.docbuilderservice

Class DocBuilderRequest

java.lang.Object

com.onlyoffice.model.docbuilderservice.DocBuilderRequest

All Implemented Interfaces:

RequestEntity

public class DocBuilderRequest
extends Object
implements RequestEntity

Field Summary

Fields

Modifier and Type	Field and Description
private Object	argument Defines the arguments to pass to the created document.
private Boolean	async Defines the type of the request to the document builder service: asynchronous or not.
private String	key Defines the request identifier used to unambiguously identify the request.
private String	token Defines the encrypted signature added to the ONLYOFFICE Docs config in the form of a token.
private String	url Defines the absolute URL to the .docbuilder file.

Constructor Summary

Constructors

Constructor and Description
DocBuilderRequest()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.onlyoffice.model.common.RequestEntity

getKey, getToken, setToken

Field Detail

argument

private Object argument

Defines the arguments to pass to the created document.

async

private Boolean async

Defines the type of the request to the document builder service: asynchronous or not.

key

private String key

Defines the request identifier used to unambiguously identify the request. The key is formed on the document builder service side and is returned as the response to the first request. When the asynchronous request is used (the async parameter is set to true) the key is not present in the first request, but must be present in all the following requests which will be send before the generation is complete. When the synchronous request is used (the async parameter is set to false), this parameter is not required.

token

private String token

Defines the encrypted signature added to the ONLYOFFICE Docs config in the form of a token.

url

private String url

Defines the absolute URL to the .docbuilder file.

Constructor Detail

DocBuilderRequest

public DocBuilderRequest()