AbstractGetSharePointFileService Class

Abstract SharePoint service that serves SharePoint files.

Inheritance Hierarchy

System.Object
  CMS.Routing.Web.ActionResultServiceBase
    CMS.Routing.Web.GetFileService
      CMS.SharePoint.AbstractGetSharePointFileService

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 13.0.131

Syntax

public abstract class AbstractGetSharePointFileService : GetFileService

The AbstractGetSharePointFileService type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractGetSharePointFileService

Fields

	Name	Description
Protected field Static member	CACHE_SIZE_PARAMETER	Name of the query parameter for cache size limit setting.
Protected field Static member	CACHE_TIME_PARAMETER	Name of the query parameter for cache minutes setting.
Protected field Static member	IMAGE_HEIGHT_PARAMETER	Name of the query parameter for image height setting.
Protected field Static member	IMAGE_MAXSIDESIZE_PARAMETER	Name of the query parameter for image max side size setting.
Protected field Static member	IMAGE_WIDTH_PARAMETER	Name of the query parameter for image width setting.

Properties

	Name	Description
Protected property	AllowCache	Returns true if the process allows cache.
Protected property	AllowClientCache	Returns true if client cache is allowed for the current request. (Inherited from GetFileService.)
Protected property	CacheFileSizeLimit	Maximum size of the file that will be cached (bytes).
Protected property	CacheItemName	Gets the cache item name for currently requested file that will be used when composing the cache key.
Protected property	CacheMinutes	Number of minutes the file will be cached. Zero means the file won't be cached.
Protected property	ClientCacheMinutes	Client cache minutes. (Inherited from GetFileService.)
Protected property	ForceDownload	Indicates whether file forced to be saved on client
Protected property	Height	Image height.
Protected property	IsLiveSite	Indicates if live site mode. (Inherited from GetFileService.)
Protected property	MaxSideSize	Image maximum side size.
Protected property	RequestStatusEnum	Gets current request URL rewriting status. (Inherited from GetFileService.)
Protected property	RevalidateClientCache	Indicates if client cache should be revalidated. (Inherited from GetFileService.)
Protected property	Width	Image width.

Methods

	Name	Description
Protected method	ETagsMatch	Checks if given and requested ETags match and object has current timestamp. (Inherited from ActionResultServiceBase.)
Protected method	FileNotFound	Responds HTTP code 404 Not Found. (Inherited from ActionResultServiceBase.)
Protected method	Forbidden	Responds HTTP code 403 Forbidden. (Inherited from ActionResultServiceBase.)
Public method	GetActionResult	Process the request. (Inherited from ActionResultServiceBase.)
Protected method	GetActionResultInternal	Process get SharePoint file request. (Overrides ActionResultServiceBase.GetActionResultInternal().)
Protected method	GetIfModifiedSinceRequestHeader	Returns the value of If-Modified-Since HTTP header or null if the header not found. (Inherited from ActionResultServiceBase.)
Protected method	GetSharePointFile	Gets the requested SharePoint file.
Protected method	HandleClientCache	Sets client cache headers. Returns CMSNotModifiedResult when requested file is in client's cache, null otherwise. (Inherited from GetFileService.)
Protected method	HasIfModifiedSinceRequestHeader	Returns true when non-empty If-Modified-Since header is present in current request. (Inherited from ActionResultServiceBase.)
Protected method	LoadFile()	Loads requested SharePoint file. Image is resized when needed.
Protected method	LoadFile(CacheSettings)	Loads requested SharePoint file. Loaded file will be cached if it satisfies the cache conditions.
Protected method	SendFile	Sends the given file within response.
Protected method	SetResponseHeaders	Sets response headers. (Inherited from GetFileService.)
Protected method	Unauthorized	Responds HTTP code 401 Unauthorized. (Inherited from ActionResultServiceBase.)
Protected method	ValidateRequest	Validates the request. Returns true on success.