com.onlyoffice.model.commandservice

Class CommandRequest

java.lang.Object

com.onlyoffice.model.commandservice.CommandRequest

All Implemented Interfaces:

RequestEntity

public class CommandRequest
extends Object
implements RequestEntity

Defines the request parameters that are sent to the "https://documentserver/command" address where "documentserver" is the name of the server with the ONLYOFFICE Document Server installed.

Field Summary

Fields

Modifier and Type	Field and Description
private Command	c Defines the command type.
private String	key Defines the document identifier used to unambiguously identify the document file.
private Meta	meta Defines the new meta information of the document.
private String	token Defines the encrypted signature added to the Document Server config in the form of a token.
private String	userdata Defines some custom identifier which will help distinguish the specific request in case there were more than one.
private List<String>	users Defines the list of the user identifiers.

Constructor Summary

Constructors

Constructor and Description
CommandRequest()

Method Summary

Modifier and Type	Method and Description
String	getToken() Returns a token from the command request.
void	setToken(String tn) Adds a token to the command 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

c

private Command c

Defines the command type.

key

private String key

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

users

private List<String> users

Defines the list of the user identifiers.

userdata

private String userdata

Defines some custom identifier which will help distinguish the specific request in case there were more than one.

meta

private Meta meta

Defines the new meta information of the document.

token

private String token

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

Constructor Detail

CommandRequest

public CommandRequest()

Method Detail

getToken

public String getToken()

Returns a token from the command request.

Specified by:

getToken in interface RequestEntity

Returns:

The token from the command request.

setToken

public void setToken(String tn)

Adds a token to the command request.

Specified by:

setToken in interface RequestEntity

Parameters:

tn - The token.