| DocumentRESTService Methods |
The DocumentRESTService type exposes the following members.
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 correct serialization format of given DataSet.
(Inherited from BaseRESTService.) |
| EnsureCorrectFormat(DataTable, String) |
Ensures correct serialization format of given DataTable.
(Inherited from BaseRESTService.) |
| EnsureSensitiveColumns |
Clears sensitive column values if needed.
(Inherited from BaseRESTService.) |
| 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 BaseRESTServiceGetExportSettings(String).) |
| 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 BaseRESTServiceGetObjectDataSetFeed(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(IEnumerableTreeNode, ExportObjectSettings) |
Returns response for modifying methods - ID and GUID of the modified object.
|
| GetStream |
Returns proper stream from given object.
(Overrides BaseRESTServiceGetStream(Object, String, ExportObjectSettings).) |
| GetTotalRecordsTable |
Returns table containing one column and one row with total records number.
(Inherited from BaseRESTService.) |
| CheckQueryStringParameters |
Checks WHERE, ORDER BY and COLUMNS query string parameters so non-admin users cannot use malicious code (= SQL injection protection).
(Inherited from BaseRESTService.) |
| IsAuthorizedForDocumentType |
Returns true if given document type is allowed in settings.
|
| IsAuthorizedForObject(BaseInfo, PermissionsEnum) | Obsolete.
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.) |
| IsAuthorizedForObject(BaseInfo, PermissionsEnum, String) |
Returns true if current user is granted with specified permission to process operation on the given objecttype.
(Inherited from BaseRESTService.) |
| IsObjectTypeAllowed |
Returns true if given object type is allowed to be accessible by the service.
(Inherited from BaseRESTService.) |
| ReturnForbiddenStatus |
Sets the response status to Forbidden.
(Inherited from BaseRESTService.) |
| ReturnNotFoundStatus |
Sets the response status to Not found.
(Inherited from BaseRESTService.) |
| SetObjectInternal |
Deletes given objects and returns it as a result.
(Inherited from BaseRESTService.) |
| Translate |
Gateway for submitting 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.) |
See Also