Enables scripted content fragments to get user folder information.

Properties

NameTypeDescriptionDefaultOptions
CurrentUserFolderCurrent User Folder

Methods

Create

Creates a user folder

Usage

#set($userFolderResponse = $core_v2_userFolder.Create($folderName, $parentFolderPath))

Parameters

NameTypeDescriptionRequiredDefaultOptions
folderNamestringFolder NameRequired
parentFolderPathstringParent Folder PathRequired

Return Type

UserFolder

Delete

Deletes a user folder

Usage

#set($additionalInfoResponse = $core_v2_userFolder.Delete($folderPath))

Parameters

NameTypeDescriptionRequiredDefaultOptions
folderPathstringFolder PathRequired

Return Type

AdditionalInfo

Get

Gets a user folder

Usage

#set($userFolderResponse = $core_v2_userFolder.Get($userId, $folderPath))

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdintUser IdRequired
folderPathstringFolder PathRequired

Return Type

UserFolder

GetParent

Gets a user parent user folder

Usage

#set($userFolderResponse = $core_v2_userFolder.GetParent($userId, $folderPath))

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdintUser IdRequired
folderPathstringFolder PathRequired

Return Type

UserFolder

List

Lists user folders

Usage

#set($apiListResponse = $core_v2_userFolder.List($userId, $folderPath))

Parameters

NameTypeDescriptionRequiredDefaultOptions
userIdintUser IdRequired
folderPathstringFolder PathRequired

Return Type

ApiList<UserFolder>