DocumentRESTService Members

Kentico 8.1 API Reference

The DocumentRESTService type exposes the following members.

Constructors

	Name	Description
	DocumentRESTService

Methods

	Name	Description
	CombineDocTypes	Combines (intersection) requested and allowed document types to use in SelectDocuments methods.
	CreateDocument	Creates new document.
	DeleteDocument	Deletes given document.
	DeleteObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
	EnsureCorrectFormat(DataSet, String)	Ensures corrent serialization format of given DataSet. (Inherited from BaseRESTService.)
	EnsureCorrectFormat(DataTable, String)	Ensures corrent serialization format of given DataTable. (Inherited from BaseRESTService.)
	EnsureSensitiveColumns	Cleares sensitive column values if needed. (Inherited from BaseRESTService.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetDocument	Selects tree node(s) according to provided parameters and returns them as dataset. Three oprations are supported: document (= select single document), all (= select documents), childrenof (= all children of given node). If classNames not specified, the result does not contain coupled data.
	GetExportSettings	Creates ExportObjectSettings object from query string parameters. (Overrides BaseRESTService GetExportSettings(String).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjectByIDInternal(String, String)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
	GetObjectByIDInternal(String, String, Boolean)	Returns object of given type with specified ID. (Inherited from BaseRESTService.)
	GetObjectByNameInternal(String, String, String)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
	GetObjectByNameInternal(String, String, String, Boolean)	Returns object of given type with specified name from specified site. (Inherited from BaseRESTService.)
	GetObjectDataSetFeed	Returns SyndicationFeed of object dataset. (Overrides BaseRESTService GetObjectDataSetFeed(DataSet, String, ExportObjectSettings).)
	GetObjects	Returns list of objects of given type. (Inherited from BaseRESTService.)
	GetResponse(GeneralizedInfo, ExportObjectSettings)	Returns response for modifying methods - ID and GUID of the modified object. (Inherited from BaseRESTService.)
	GetResponse(IEnumerable TreeNode , ExportObjectSettings)	Returns response for modifying methods - ID and GUID of the modified object.
	GetStream	Returns proper stream from given object. (Overrides BaseRESTService GetStream(Object, String, ExportObjectSettings).)
	GetTotalRecordsTable	Returns table containing one olumn and one row with total records number. (Inherited from BaseRESTService.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	CheckQueryStringParameters	Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malitious code (= SQL injection protection). (Inherited from BaseRESTService.)
	IsAuthorizedForDocumentType	Returns true if given document type is allowed in settings.
	IsAuthorizedForObject(BaseInfo, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
	IsAuthorizedForObject(String, String, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype. (Inherited from BaseRESTService.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReturnForbiddenStatus	Sets the response status to Forbidden. (Inherited from BaseRESTService.)
	SetObjectInternal	Deletes given objects and returns it as a result. (Inherited from BaseRESTService.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Translate	Gateway for submiting an XLIFF document.
	UpdateDocument	Processes given document.

Extension Methods

	Name	Description
	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
	AllowedDocumentTypes	Gets the list of allowed document types separated by semicolon. Empty string means all document types are allowed.
	AllowedObjectTypes	Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed. (Inherited from BaseRESTService.)
	AllowedSensitiveColumns	If true, global administrators will be able to work with sensitive columns (such as UserPassword) via REST service. Other users than global administrators cannot work with these columns regardless this setting value. (Inherited from BaseRESTService.)
	CurrentSite	Gets current site object recieved from the domain. (Inherited from BaseRESTService.)
	CurrentSiteName	Gets current site name (retrieved from domain accessed). (Inherited from BaseRESTService.)
	CurrentUser	Gets current user object recieved from auth cookie. (Inherited from BaseRESTService.)
	CurrentUserName	Gets current user name recieved from auth cookie. (Inherited from BaseRESTService.)
	DefaultEncoding	Returns default Encoding from settings. (Inherited from BaseRESTService.)