ISharePointFileService Interface

Provides access to SharePoint files.

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

Syntax

public interface ISharePointFileService : ISharePointService

The ISharePointFileService type exposes the following members.

Methods

	Name	Description
Public method	DeleteFile	Deletes the file specified by serverRelativeUrl from the SharePoint server. Deleting a non-existent file within SharePoint site is a void action. Throws exception when serverRelativeUrl is invalid (does not point within any SharePoint site).
Public method	GetFile	Gets SharePoint file identified by server relative URL. The file may be loaded eagerly or lazily (depends on implementation). In such case an invalid serverRelativeUrl is not reported immediately.
Public method	IsConnectionSupported	Tells you whether connection parameters can be used by instantiated SharePoint service implementation (eg. the authentication mode might not be supported). (Inherited from ISharePointService.)
Public method	RecycleFile	Moves the file specified by serverRelativeUrl to the recycle bin of the SharePoint server. Returns the identifier of the new recycle bin item. Recycling a non-existent file within SharePoint site returns empty GUID. Throws exception when serverRelativeUrl is invalid (does not point within any SharePoint site).
Public method	UpdateFile	Updates file identified by serverRelativeUrl. New content and file name can be provided.
Public method	UploadFile	Uploads the file's content specified as a stream to the serverRelativeUrl location.