FolderItem

Since: 25.6

Properties

Name
Type
Access
Min Version
Description
type
number
R
25.6
Get the type of the Project Item.
name
string
R
25.6
The name of this project item.

Static Methods

cast

Cast ProjectItem in to FolderItem

Since: 25.6

Returns: FolderItem

Parameters

Name
Type
Description
projectItem
ProjectItem
-

Instance Methods

createBinAction

Returns an action that lets users create a new bin.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
name
string
-
makeUnique
boolean
-

createMoveItemAction

Creates an action that moves the given item to the provided folder item newParent.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
item
ProjectItem
-
newParent
FolderItem
-

createRemoveItemAction

Creates an action that removes the given item from this folder.

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
item
ProjectItem
-

createRenameBinAction

Rename the Bin and return true if it's successful

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
name
string
-

createSetColorLabelAction

Create an action for set color label to projectItem by index

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
inColorLabelIndex
number
-

createSetNameAction

Returns action that renames projectItem

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
inName
string
-

createSmartBinAction

Creates a smart bin with given name and returns the Folder object

Since: 25.6

Returns: Action

Parameters

Name
Type
Description
name
string
-
searchQuery
string
-

getColorLabelIndex

Get color label index of projectItem

Since: 25.6

Returns: Promise<number>

getItems

Collection of child items of this folder.

Since: 25.6

Returns: Promise<ProjectItem[]>

getProject

Get the parent Project of this projectItem.

Since: 25.6

Returns: Promise<Project>