core_v2_userFolder Script API

Enables scripted content fragments to get user folder information.

Properties

Name	Access	Type	Description
Current	Read	`UserFolder`	Current User Folder

Creates a user folder

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

var userFolderResponse = core_v2_userFolder.Create(folderName, parentFolderPath);

Name	Type	Description	Required	Default	Options
folderName	`String`	Folder Name	Required
parentFolderPath	`String`	Parent Folder Path	Required

UserFolder

Deletes a user folder

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

var additionalInfoResponse = core_v2_userFolder.Delete(folderPath);

Name	Type	Description	Required	Default	Options
folderPath	`String`	Folder Path	Required

AdditionalInfo

Gets a user folder

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

var userFolderResponse = core_v2_userFolder.Get(userId, folderPath);

Name	Type	Description	Required	Default	Options
userId	`Int32`	User Id	Required
folderPath	`String`	Folder Path	Required

UserFolder

Gets a user parent user folder

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

var userFolderResponse = core_v2_userFolder.GetParent(userId, folderPath);

Name	Type	Description	Required	Default	Options
userId	`Int32`	User Id	Required
folderPath	`String`	Folder Path	Required

UserFolder

Lists user folders

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

var apiListResponse = core_v2_userFolder.List(userId, folderPath);

Name	Type	Description	Required	Default	Options
userId	`Int32`	User Id	Required
folderPath	`String`	Folder Path	Required

ApiList of UserFolder

Recommended