# Folder

The Folder object is of type *Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities.Folder* and grants direct access to the Vault folder where the Job is triggered on.

## Syntax

```{code-block} PowerShell
:linenos:

$folder.FullName
```

Following properties are available :

| Type     | Name              | Description                                                                                                                                                                                                      | Access type |
| -------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|          | Category          | Gets the category that is assigned to this folder. This can be null as not all products support categories.                                                                                                      | read-only   |
| DateTime | CreateDate        | Gets the date and time that the folder was created.                                                                                                                                                              | read-only   |
| long     | CreateUserId      | Gets the ID of the user who crated this folder.                                                                                                                                                                  | read-only   |
| string   | CreateUserName    | Gets the name of the user who created this folder.                                                                                                                                                               | read-only   |
|          | EntityClass       | Gets the entity class associated with this Folder.                                                                                                                                                               | read-only   |
| long     | EntityIterationId | Gets the Iteration ID of this Folder. Since Folders are not iteration based, this will always have the same value as the EntityMasterId.                                                                         | read-only   |
| long     | EntityMasterId    | Gets the Master Id of this Folder. Folders are not iteration based and the MasterID is always the sole unique identifier for a folder.                                                                           | read-only   |
| string   | EntityName        | Gets the descriptive name for this Folder. This is always the Folder Name without the full path.                                                                                                                 | read-only   |
| string   | FolderPath        | Gets the path of the location of this folder. If this folder is \$/Folder1/Folder2, then the path would be \$/Folder1.<br>In the case where this folder is the root (\$), the returned path is the empty string. | read-only   |
| string   | FullName          | Gets the full vault path for this folder (ie. "\$/Folder1").                                                                                                                                                     | read-only   |
| string   | FullUncName       | Gets the full UNC path for this folder, or null if no UNC path exists.                                                                                                                                           | read-only   |
| long     | Id                | Gets the unique identifier for this folder.                                                                                                                                                                      | read-only   |
| bool     | IsCloaked         | Gets if this folder is cloaked. A cloaked object is one that the caller does not have permissions to view.<br>The only valid data in a cloaked folder is the EntityMasterId. All other data will be null or 0.   | read-only   |
| bool     | IsLibraryFolder   | Gets whether or not this folder is a library folder.                                                                                                                                                             | read-only   |
| bool     | IsVaultRoot       | Gets whether or not this folder is the vault root folder.                                                                                                                                                        | read-only   |
|          | LinkInfo          | Gets if this is a Link to a Folder. If the value is not null, then LinkInfo provides information about the Link to this Folder.                                                                                  | read-only   |
| bool     | Locked            | Gets whether this folder can be modified by the logged in user.                                                                                                                                                  | read-only   |
| int      | NumberOfChildren  | Gets the number of immediate child folders.                                                                                                                                                                      | read-only   |
|          | Parent            | Gets or sets the parent folder. It is important to note that this CAN be null.<br>A folder always has a parent ID but the full blown object might not have been loaded.                                          | read-only   |
| long     | ParentId          | Gets the Id of this folders parent. A value of -1 means that this folder has no parent.                                                                                                                          | read-only   |

## Remarks

The \$folder variable is available when a Job is triggered with these parameters:

- EntityClassId = FLDR
- EntityId = \<Id of the folder>

Also the LifecycleEventEditor triggers the Job with this parameters.

All the properties of the Folder object are part of the Vault API.\
You can look them up in the VaultSDK documentation under *Folder Class Members*.