Scripting API / core/FolderApi

core/FolderApi

Modules

Module	Description
External	-

Classes

FolderApi

Methods

create()

create(name, parentFolderId?): Promise<number>

Creates a new Folder.

Parameters

Parameter	Type	Description
name	string	The name of the new Folder.
parentFolderId?	number	The id of the parent Folder that this new Folder should be created in. If not set, the new Folder will be created in the Root Folder.

Returns

Promise<number>

get()

get(id?): Promise<SingleFolder>

Retrieves information for an existing Folder. Throws an error if the Folder does not exist.

Parameters

Parameter	Type	Description
id?	number	The id of the Folder to retrieve.

Returns

Promise<SingleFolder>