Enables scripted content fragments to get user folder information.
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | UserFolder | Current User Folder |
Methods
Create
Creates a user folder
Usage
#set($userFolderResponse = $core_v2_userFolder.Create($folderName, $parentFolderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
folderName | string | Folder Name | Required | ||
parentFolderPath | string | Parent Folder Path | Required |
Return Type
Delete
Deletes a user folder
Usage
#set($additionalInfoResponse = $core_v2_userFolder.Delete($folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
folderPath | string | Folder Path | Required |
Return Type
Get
Gets a user folder
Usage
#set($userFolderResponse = $core_v2_userFolder.Get($userId, $folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
folderPath | string | Folder Path | Required |
Return Type
GetParent
Gets a user parent user folder
Usage
#set($userFolderResponse = $core_v2_userFolder.GetParent($userId, $folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
folderPath | string | Folder Path | Required |
Return Type
List
Lists user folders
Usage
#set($apiListResponse = $core_v2_userFolder.List($userId, $folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
folderPath | string | Folder Path | Required |