UserFolders In-Process API Service

Work with User's folders

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

Events

Events.AfterCreate

Handler

void UserFolderAfterCreateEventHandler(UserFolderAfterCreateEventArgs e);

Events.AfterDelete

Handler

void UserFolderAfterDeleteEventHandler(UserFolderAfterDeleteEventArgs e);

Events.AfterUpdate

Handler

void UserFolderAfterUpdateEventHandler(UserFolderAfterUpdateEventArgs e);

Events.BeforeCreate

Handler

void UserFolderBeforeCreateEventHandler(UserFolderBeforeCreateEventArgs e);

Events.BeforeDelete

Handler

void UserFolderBeforeDeleteEventHandler(UserFolderBeforeDeleteEventArgs e);

Events.BeforeUpdate

Handler

void UserFolderBeforeUpdateEventHandler(UserFolderBeforeUpdateEventArgs e);

Methods

UserFolder Create(string folderName, string parentFolderPath);

Create a new User's folder

Parameters

Name	Type	Description	Required	Default	Options
folderName	`string`	Folder name. E.g. 'testolder	Required
parentFolderPath	`string`	Specified parent folder path. E.g. 'testolder	Required

Return Type

UserFolder

AdditionalInfo Delete(string folderPath);

Delete a User's folder for the accessing user

Parameters

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

Return Type

AdditionalInfo

UserFolder Get(int userId, string folderPath);

Get a User folder

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
folderPath	`string`	Specified folder path. E.g. 'testolder	Required

Return Type

UserFolder

UserFolder GetParent(int userId, string folderPath);

Get a parent User's folder

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
folderPath	`string`	Specified folder path. E.g. 'testolder	Required

Return Type

UserFolder

ApiList<UserFolder> List(int userId, string folderPath);

Get a User folders list

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
folderPath	`string`	Specified folder path. E.g. 'testolder	Required

Return Type

ApiList<UserFolder>

Recommended