SDK
API Documentation
folder
namespaces
Folder
type-aliases
Folder

Type Alias: Folder

Folder: object

A folder in the filesystem.

Type declaration

assetCount

assetCount: number

Count of all assets in this folder, taking into account all subfolders

content?

optional content: OffsetBasedPaginationResponse<FileSystemEntity<Asset | Folder>>

Folder content as a paginated filesystem result.

contentSummary

contentSummary: object

Summary of the folders content without the need to look into content and tally results.

contentSummary.assetCount

contentSummary.assetCount: number

Count of all assets in this folder, not taking into account all subfolders

contentSummary.coverImages

contentSummary.coverImages: FolderCoverImage[]

The cover images of assets in this folder.

contentSummary.folderCount

contentSummary.folderCount: number

Count of all folders in this folder, not taking into account all subfolders

createdAt

createdAt: Date

description

description: string

id

id: FolderId

isNestingLevelReached

isNestingLevelReached: boolean

Whether the current position in the nesting level of this folder has reached the maximum allowed nesting level.

modifiedAt

modifiedAt: Date

name

name: string

nestingLevel

nestingLevel: number

Nesting level of the folder in the filesystem. Zero based.

A nesting level of 0 means that this is the root folder of the project. A project can have only one root folder.

parentId?

optional parentId: FolderId

Id of the parent folder of this folder. Can be undefined if this is the root folder of a project.

path

path: FolderPathEntry[]

Upstream path to the current folder in the filesystem. Useful for breadcrumbs.

Defined in

types.ts:7 (opens in a new tab)