FolderItem

Properties

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

Static Methods

cast

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

FolderItem

Cast ProjectItem in to FolderItem

Parameters

Name
Type
Description
projectItem
ProjectItem
-

Instance Methods

createBinAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Returns an action that lets users create a new bin.

Parameters

Name
Type
Description
name
string
-
makeUnique
boolean
-

createMoveItemAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

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

Parameters

Name
Type
Description
item
ProjectItem
-
newParent
FolderItem
-

createRemoveItemAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

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

Parameters

Name
Type
Description
item
ProjectItem
-

createRenameBinAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Rename the Bin and return true if it's successful

Parameters

Name
Type
Description
name
string
-

createSetColorLabelAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Create an action for set color label to projectItem by index

Parameters

Name
Type
Description
inColorLabelIndex
number
-

createSetNameAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

Returns action that renames projectItem

Parameters

Name
Type
Description
inName
string
-

createSmartBinAction

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Action

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

Parameters

Name
Type
Description
name
string
-
searchQuery
string
-

getColorLabelIndex

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

number

Get color label index of projectItem

getItems

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

ProjectItem[]

Collection of child items of this folder.

getProject

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">25.0</span>

Project

Get the parent Project of this projectItem.