com.onlyoffice.model.convertservice

Class ConvertRequest

java.lang.Object

com.onlyoffice.model.convertservice.ConvertRequest

All Implemented Interfaces:

RequestEntity

public class ConvertRequest
extends Object
implements RequestEntity

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	async Defines the conversion request type: asynchronous or not.
private Integer	codePage Defines the file encoding when converting from "csv" or "txt" format.
private Integer	delimiter Defines the delimiter characters for separating values when converting from "csv" format.
private String	filetype Defines the type of the document file to be converted.
private String	key Defines the document identifier used to unambiguously identify the document file.
private String	outputtype Defines the resulting converted document type.
private String	password Defines the password for the document file if it is protected with a password.
private PDF	pdf Defines settings for converting document files to pdf.
private String	region Defines the default display format for currency and date and time when converting from "Spreadsheet format" to "pdf".
private Thumbnail	thumbnail Defines the settings for the thumbnail when specifying the image formats ("bmp", "gif", "jpg", "png") as "outputtype".
private String	title Defines the converted file name.
private String	token Defines the encrypted signature added to the Document Server config in the form of a token.
private String	url Defines the absolute URL to the document to be converted.

Constructor Summary

Constructors

Constructor and Description
ConvertRequest()

Method Summary

Modifier and Type	Method and Description
String	getToken() Returns a token from the conversion request.
void	setToken(String tn) Adds a token to the conversion request.

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

Field Detail

async

private Boolean async

Defines the conversion request type: asynchronous or not. When the asynchronous request type is used, the response is formed instantly. In this case to get the result it is necessary to send requests without parameter change until the conversion is finished. The default value is "false".

codePage

private Integer codePage

Defines the file encoding when converting from "csv" or "txt" format. Main supported values: "932" - Japanese (Shift-JIS), "950" - Chinese Traditional (Big5), "1250" - Central European (Windows), "1251" - Cyrillic (Windows), "65001" - Unicode (UTF-8).

See Also:

All the supported values

delimiter

private Integer delimiter

Defines the delimiter characters for separating values when converting from "csv" format. Supported values: "0" - no delimiter, "1" - tab, "2" - semicolon, "3" - colon, "4" - comma, "5" - space.

filetype

private String filetype

Defines the type of the document file to be converted.

key

private String key

Defines the document identifier used to unambiguously identify the document file.

outputtype

private String outputtype

Defines the resulting converted document type. Starting from version 7.0, file formats can be specified instead of extensions. They are used when we do not know in advance what extension is required. "ooxml" - defines that the file will be converted into "docx", "docm", "xlsx", "xlsm", "pptx" or "pptm". For example, when the "doc" file is converted into the OOXML format, the resulting file can be "docx" or "docm" if this file contains macros (the same for "xls" and "ppt"). It is also applied when converting XML files into OOXML formats ("docx", "xlsx" or "pptx" depending on the content). "odf" - defines that the file will be converted into "odt", "ods" or "odp". For example, it is used when converting XML files into ODF formats ("odt", "ods" or "odp" depending on the content).

pdf

private PDF pdf

Defines settings for converting document files to pdf.

password

private String password

Defines the password for the document file if it is protected with a password.

region

private String region

Defines the default display format for currency and date and time when converting from "Spreadsheet format" to "pdf". Is set using the four letter ("en-US", "fr-FR", etc.) language codes. The default value is "en-US".

thumbnail

private Thumbnail thumbnail

Defines the settings for the thumbnail when specifying the image formats ("bmp", "gif", "jpg", "png") as "outputtype".

title

private String title

Defines the converted file name.

token

private String token

Defines the encrypted signature added to the Document Server config in the form of a token.

url

private String url

Defines the absolute URL to the document to be converted. Be sure to add a token when using local links. Otherwise, an error will occur.

Constructor Detail

ConvertRequest

public ConvertRequest()

Method Detail

getToken

public String getToken()

Returns a token from the conversion request.

Specified by:

getToken in interface RequestEntity

Returns:

The token from the conversion request.

setToken

public void setToken(String tn)

Adds a token to the conversion request.

Specified by:

setToken in interface RequestEntity

Parameters:

tn - The token.