UserFiles In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:15 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:15

Work with User's files

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IUserFiles>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void UserFileAfterCreateEventHandler([[UserFileAfterCreateEventArgs In-Process API Event Argument|UserFileAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void UserFileAfterDeleteEventHandler([[UserFileAfterDeleteEventArgs In-Process API Event Argument|UserFileAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void UserFileAfterUpdateEventHandler([[UserFileAfterUpdateEventArgs In-Process API Event Argument|UserFileAfterUpdateEventArgs]] e);

Events.BeforeDelete

Handler

void UserFileBeforeDeleteEventHandler([[UserFileBeforeDeleteEventArgs In-Process API Event Argument|UserFileBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void UserFileBeforeUpdateEventHandler([[UserFileBeforeUpdateEventArgs In-Process API Event Argument|UserFileBeforeUpdateEventArgs]] e);

Methods

UserFile Create(Byte[] fileData, string fileName, string folderPath);

Create a User file

Parameters

Name	Type	Description	Required
fileData	`Byte[]`	File content	Required
fileName	`string`	Specified file name	Required
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required

Return Type

[[UserFile In-Process API Supplementary Type|UserFile]]

UserFile Create(Stream fileStream, string fileName, string folderPath);

Create a User file

Parameters

Name	Type	Description	Required
fileStream	`Stream`	File content	Required
fileName	`string`	Specified file name	Required
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required

Return Type

[[UserFile In-Process API Supplementary Type|UserFile]]

UserFile Create(string fileUploadContext, string fileName, string folderPath);

Create a User file

Parameters

Name	Type	Description	Required
fileUploadContext	`string`	File Upload Context	Required
fileName	`string`	Specified file name	Required
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required

Return Type

[[UserFile In-Process API Supplementary Type|UserFile]]

AdditionalInfo Delete(string folderPath, string fileName);

Delete a User file

Parameters

Name	Type	Description	Required	Default	Options
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required
fileName	`string`	Specified file name	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo Delete(string folderPath, string fileName, UserFileDeleteOptions options = null);

Delete a User file

Parameters

Name	Type	Description	Required
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required
fileName	`string`	Specified file name	Required
options	`[[UserFileDeleteOptions In-Process API Supplementary Type\|UserFileDeleteOptions]]`	User's file values for delete operation	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

UserFile Get(int userId, string folderPath, string fileName);

Get User File for a user

Parameters

Name	Type	Description	Required
userId	`int`	Specified a user id	Required
folderPath	`string`	Specified folder path. E.g. 'testolder'	Required
fileName	`string`	Specified file name	Required

Return Type

[[UserFile In-Process API Supplementary Type|UserFile]]

PagedList<UserFile> List(int userId, UserFileListOptions options = null);

List user files for a user

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	Specified a user id	Required
options	`[[UserFileListOptions In-Process API Supplementary Type\|UserFileListOptions]]`	User file list get options	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[UserFile In-Process API Supplementary Type|UserFile]]>