WebApi-контроллер, предназначенный для загрузки файлов на сервер и скачивания ранее загруженных файлов. Подробнее...

Граф наследования:NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController:

Открытые члены
HttpResponseMessage	Get ([FromUri] FileDescription fileDescription=null, [FromUri] bool getPreview=false)
	Осуществляет скачивание файлов с сервера. В зависимости от значения флага getPreview возвращается либо содержимое файла, либо файл в виде приложения. Подробнее...

Task< FileDescription >	Post ()
	Осуществляет загрузку файлов на сервер. Подробнее...

Открытые статические члены
static string	GetFileUploadDirectoryPath (string fileUploadKey)
	Получает путь к подкаталогу с заданным именем внутри каталога UploadsDirectoryPath. Подробнее...

static string	CreateFileUploadDirectory (string fileUploadKey)
	Осуществляет создание подкаталога с заданным именем в каталоге UploadsDirectoryPath. Подробнее...

static void	RemoveFileUploadDirectory (string fileUploadKey)
	Осуществляет удаление подкаталога с заданным именем из каталога UploadsDirectoryPath. Подробнее...

static void	RemoveFileUploadDirectories (List< FileDescription > removingFileDescriptions)
	Осуществляет удаление подкаталогов, соответствующих загруженным файлам, из каталога UploadsDirectoryPath. Подробнее...

static bool	HasDataObjectFileProvider (Type dataObjectFilePropertyType)
	Проверяет имеется ли в контроллере зарегистрированный провайдер для заданного типа файловых свойств объектов данных. Подробнее...

static void	RegisterDataObjectFileProvider (IDataObjectFileProvider dataObjectFileProvider)
	Осуществляет регистрацию провайдера файловых свойств для объекта данных. Подробнее...

static IDataObjectFileProvider	GetDataObjectFileProvider (Type dataObjectFilePropertyType)
	Получает зарегистрированный провайдер для заданного типа файловых свойств объектов данных. Подробнее...

static List< FileDescription >	GetDataObjectFileDescriptions (DataObject dataObject, List< Type > excludedFilePropertiesTypes=null)
	Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих всем типам файловых свойств, для которых есть зарегистрированные провайдеры. Подробнее...

static string	GetBase64StringFileData (string contentType, Stream stream)
	Осуществляет получение данных файла в виде Base64String. Подробнее...

static string	GetBase64StringFileData (string filePath)
	Осуществляет получение данных файла в виде Base64String. Подробнее...

Свойства
static string	RouteName `[get, set]`
	Получает или задает URL, по которому доступен контроллер. Подробнее...

static string	UploadsDirectoryPath `[get, set]`
	Получает или задает путь до каталога, предназначенного для хранения загруженных файлов. Подробнее...

static string	BaseUrl `[get, set]`
	Получает или задает URL, по которому доступен контроллер. Подробнее...

Дополнительные унаследованные члены
Защищенные члены унаследованные от NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.BaseApiController
override void	Initialize (HttpControllerContext controllerContext)
	Осуществляет инициализацию, которая должна выполниться до начала обработки какого-либо запроса. Подробнее...

Подробное описание

WebApi-контроллер, предназначенный для загрузки файлов на сервер и скачивания ранее загруженных файлов.

Методы

static string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.CreateFileUploadDirectory ( string fileUploadKey )

inlinestatic

Осуществляет создание подкаталога с заданным именем в каталоге UploadsDirectoryPath.

Аргументы

fileUploadKey Ключ загрузки файла (используется как имя создаваемого подкаталога).

Возвращает: Путь к созданному подкаталогу.

HttpResponseMessage NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.Get	(	[FromUri] FileDescription	fileDescription = `null`,
		[FromUri] bool	getPreview = `false`
	)

inline

Осуществляет скачивание файлов с сервера. В зависимости от значения флага getPreview возвращается либо содержимое файла, либо файл в виде приложения.

Аргументы

fileDescription	Описание запрашиваемого файла.
getPreview	Параметр, определяющий, требуется ли файл просто для предпросмотра (если значение `true`), либо требуется его скачать и сохранить.

Возвращает: Описание загруженного файла.

static string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.GetBase64StringFileData	(	string	contentType,
		Stream	stream
	)

inlinestatic

Осуществляет получение данных файла в виде Base64String.

Аргументы

contentType	MIME-тип данных.
stream	Поток байтов файла.

Возвращает: Данные файла в виде Base64String.

static string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.GetBase64StringFileData ( string filePath )

inlinestatic

Осуществляет получение данных файла в виде Base64String.

Аргументы

filePath Путь к файлу.

Возвращает: Данные файла в виде Base64String.

static List<FileDescription> NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.GetDataObjectFileDescriptions	(	DataObject	dataObject,
		List< Type >	excludedFilePropertiesTypes = `null`
	)

inlinestatic

Осуществляет получение списка метаданных с описанием файловых свойств объекта данных, соответствующих всем типам файловых свойств, для которых есть зарегистрированные провайдеры.

При необходимости будет произведена дочитка объекта данных.

Аргументы

dataObject	Объект данных, содержащий файловые свойства.
excludedFilePropertiesTypes	Список типов файловых свойств объекта данных, для которых не требуется получение метаданных.

Возвращает: Список метаданных с описанием файловых свойств объекта данных, соответствующих всем типам файловых свойств, для которых есть зарегистрированные провайдеры.

static IDataObjectFileProvider NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.GetDataObjectFileProvider ( Type dataObjectFilePropertyType )

inlinestatic

Получает зарегистрированный провайдер для заданного типа файловых свойств объектов данных.

Аргументы

dataObjectFilePropertyType Тип файловыйх свойств объектов данных.

Возвращает: Провайдер файловых свойств объектов данных.

static string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.GetFileUploadDirectoryPath ( string fileUploadKey )

inlinestatic

Получает путь к подкаталогу с заданным именем внутри каталога UploadsDirectoryPath.

Аргументы

fileUploadKey Ключ загрузки файла (используется как имя подкаталога).

Возвращает: Путь к подкаталогу.

static bool NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.HasDataObjectFileProvider ( Type dataObjectFilePropertyType )

inlinestatic

Проверяет имеется ли в контроллере зарегистрированный провайдер для заданного типа файловых свойств объектов данных.

Аргументы

dataObjectFilePropertyType Тип файловыйх свойств объектов данных.

Возвращает: Флаг: true, если для файловых свойств указанного типа зарегистрирован провайдер, false в противном случае.

Task<FileDescription> NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.Post ( )

inline

Осуществляет загрузку файлов на сервер.

Файлы загружаются в файловую систему, в каталог UploadsDirectoryPath/{UploadedFileKey}, где UploadedFileGuid - Guid, идентифицирующий загруженный файл.

Возвращает: Описание загруженного файла.

static void NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.RegisterDataObjectFileProvider ( IDataObjectFileProvider dataObjectFileProvider )

inlinestatic

Осуществляет регистрацию провайдера файловых свойств для объекта данных.

Аргументы

dataObjectFileProvider Провайдер файловых свойств для объекта данных.

static void NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.RemoveFileUploadDirectories ( List< FileDescription > removingFileDescriptions )

inlinestatic

Осуществляет удаление подкаталогов, соответствующих загруженным файлам, из каталога UploadsDirectoryPath.

Аргументы

removingFileDescriptions Метаданные файлов, которые требуется удалить.

static void NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.RemoveFileUploadDirectory ( string fileUploadKey )

inlinestatic

Осуществляет удаление подкаталога с заданным именем из каталога UploadsDirectoryPath.

Аргументы

fileUploadKey Ключ загрузки файла (используется как имя удаляемого подкаталога).

Полный список свойств

string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.BaseUrl

staticgetset

Получает или задает URL, по которому доступен контроллер.

string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.RouteName

staticgetset

Получает или задает URL, по которому доступен контроллер.

string NewPlatform.Flexberry.ORM.ODataService.WebApi.Controllers.FileController.UploadsDirectoryPath

staticgetset

Получает или задает путь до каталога, предназначенного для хранения загруженных файлов.

Инициализируется при назначении роута, соответствующего этому контролеру.

Открытые члены

Открытые статические члены

Свойства

Дополнительные унаследованные члены

Подробное описание

Методы

Полный список свойств