BaseRESTService Members

Kentico 8.1 API Reference

The BaseRESTService type exposes the following members.

Constructors

	Name	Description
	BaseRESTService

Methods

	Name	Description
	DeleteObjectInternal	Deletes given objects and returns it as a result.
	EnsureCorrectFormat(DataSet, String)	Ensures corrent serialization format of given DataSet.
	EnsureCorrectFormat(DataTable, String)	Ensures corrent serialization format of given DataTable.
	EnsureSensitiveColumns	Cleares sensitive column values if needed.
	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.)
	GetCurrentSite	Retuns current site info accoding to domain in query string.
	GetCurrentSiteName	Returns current site name.
	GetCurrentUser	Returns current user.
	GetCurrentUserName	Returns current user.
	GetDefaultEncoding	Returns default encoding according to settings in Site Manager.
	GetExportSettings	Creates ExportObjectSettings object from query string parameters.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetItemUri	Returns Item Uri according to pattern.
	GetObjectByIDInternal(String, String)	Returns object of given type with specified ID.
	GetObjectByIDInternal(String, String, Boolean)	Returns object of given type with specified ID.
	GetObjectByNameInternal(String, String, String)	Returns object of given type with specified name from specified site.
	GetObjectByNameInternal(String, String, String, Boolean)	Returns object of given type with specified name from specified site.
	GetObjectDataSetFeed	Returns SyndicationFeed of object dataset.
	GetObjects	Returns list of objects of given type.
	GetObjectUri(String, ExportObjectSettings)	Returns Uri of given obejct type.
	GetObjectUri(GeneralizedInfo, ExportObjectSettings)	Returns Uri of given obejct type.
	GetQueryParam	Returns query string parameter.
	GetRequestedEncoding	Returns requested encoding or default encoding if none was specified.
	GetResponse	Returns response for modifying methods - ID and GUID of the modified object.
	GetStream	Returns proper stream from given object.
	GetTotalRecordsTable	Returns table containing one olumn and one row with total records number.
	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).
	IsAuthorizedForObject(BaseInfo, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype.
	IsAuthorizedForObject(String, String, PermissionsEnum)	Returns true if current user is granted with specified permission to process operation on the given objecttype.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReturnForbiddenStatus	Sets the response status to Forbidden.
	RewriteRESTUrl	Handles the rewriting for REST service.
	SetFormat	Sets the format according to content-type and querystring parameter (higher priority).
	SetObjectInternal	Deletes given objects and returns it as a result.
	ToODATA	Serializes given DataSet to ODATA.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WrapJSONP	Wraps JSON result to a JSONP callback method if specified.

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
	AllowedObjectTypes	Gets the list of allowed object types separated by semicolon. Empty string means all object types are allowed.
	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.
	CurrentBaseUri	Gets current base uri of the REST service
	CurrentSite	Gets current site object recieved from the domain.
	CurrentSiteName	Gets current site name (retrieved from domain accessed).
	CurrentUser	Gets current user object recieved from auth cookie.
	CurrentUserName	Gets current user name recieved from auth cookie.
	DefaultEncoding	Returns default Encoding from settings.