Class LrFolder

This class provides access to a file-system folder and to its contained photos.

Access the functions and properties from the object. Retrieve the objects for all the folders by calling LrCatalog.getFolders().

Summary

folder:getChildren()
Retrieves immediate subfolders of this folder.
folder:getName()
Retrieves the name of this folder.
folder:getParent()
Retrieves the parent of this folder.
folder:getPath()
Retrieves the path of this folder.
folder:getPhotos( includeChildren )
Retrieves the photos contained in this folder.
folder:type()
Reports the type of this object.
folder.catalog
(LrFolder) The catalog object that contains this folder.

Functions

folder:getChildren()
Retrieves immediate subfolders of this folder. Does not go into subfolders.

First supported in version 3.0 of the Lightroom SDK.

Return value

(array of LrFolder) The folder objects.
folder:getName()
Retrieves the name of this folder.

First supported in version 3.0 of the Lightroom SDK.

Return value

(string) The name.
folder:getParent()
Retrieves the parent of this folder.

First supported in version 3.0 of the Lightroom SDK.

Return value

(LrFolder) The folder object.
folder:getPath()
Retrieves the path of this folder.

First supported in version 3.0 of the Lightroom SDK.

Return value

(string) The path.
folder:getPhotos( includeChildren )
Retrieves the photos contained in this folder.

First supported in version 3.0 of the Lightroom SDK.

Parameters

1. includeChildren
(Boolean) True to include photos in subfolders in the returned set.

Return value

(array of LrPhoto) The photo objects.
folder:type()
Reports the type of this object.

First supported in version 3.0 of the Lightroom SDK.

Return value

(string) 'LrFolder'.

Properties

folder.catalog : (Read-Only)
(LrFolder) The catalog object that contains this folder.

First supported in version 3.0 of the Lightroom SDK.

See also: LrCatalog