Enables scripted content fragments to get user file information.
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | UserFile | Current User File |
Methods
Create
Creates a user file
Usage
#set($userFileResponse = $core_v2_userFile.Create($fileData, $fileName, $folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
fileData | Byte[] | File Data | Required | ||
fileName | string | File Name | Required | ||
folderPath | string | Folder Path | Required |
Return Type
Create
Creates a user file
Usage
#set($userFileResponse = $core_v2_userFile.Create($fileUploadContext, $fileName, $folderPath))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
fileUploadContext | string | File Upload Context | Required | ||
fileName | string | File Name | Required | ||
folderPath | string | Folder Path | Required |
Return Type
Delete
Deletes a user file
Usage
#set($additionalInfoResponse = $core_v2_userFile.Delete($folderPath, $fileName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
folderPath | string | Folder Path | Required | ||
fileName | string | File Name | Required |
Return Type
Delete
Deletes a user file
Usage
#set($additionalInfoResponse = $core_v2_userFile.Delete($folderPath, $fileName, "%{UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
folderPath | string | Folder Path | Required | ||
fileName | string | File Name | Required | ||
UserId | string | Contextual UserId, user whose file we should delete. If not set uses the accessing user. | Optional |
Return Type
Get
Gets a user file
Usage
#set($userFileResponse = $core_v2_userFile.Get($userId, $folderPath, $fileName))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
folderPath | string | Folder Path | Required | ||
fileName | string | File Name | Required |
Return Type
List
Lists user files
Usage
#set($pagedListResponse = $core_v2_userFile.List($userId, "%{ContentType = $contentTypeArg, FolderPath = $folderPathArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
ContentType | string | Content Type | Optional | ||
FolderPath | string | Folder Path | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort By | Optional | Name | ContentLength, ContentType, Name |
SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |