Folder object methods
- Method name
- Description
AddPermissions- Adds permissions to those already set on the folder.
CanChangePermissions- Returns a Boolean indicating whether the current user can change permissions on the folder.
CommitPermissions- Commit the permission changes for the folder to the database.
CreateFolder- Creates a new subfolder with the given name.
DeleteFolder- Deletes an existing subfolder with the given name.
DiscoverPermissionsForGroup- Returns a list of all the permissions for the named group, starting at a certain folder and including all of its subfolders.
DiscoverPermissionsForUser- Returns a list of all the permissions for the named user, starting at a certain folder and including all of its subfolders.
GetAllGroupPermissions- Returns the applied and effective permissions for all known groups on the folder.
GetAppliedPermissions- Returns the permissions applied directly to this folder that the current user is allowed to see.
GetAppliedPermissionsForGroup- Returns the permissions applied directly to the folder for a named group.
GetAppliedPermissionsForUser- Returns the permissions applied directly to the folder for a named user.
GetChildDbIds- Returns the DBIDs of children workspace items.
GetChildNames- Returns the names of children workspace items (as short names or full pathnames).
GetDbId- Returns the DBID of this folder.
GetMasterReplicaName- Returns the name of the replica that has mastership of the folder.
GetName- Returns the name of the folder.
GetParent- Returns a Folder object for the containing folder.
GetPathname- Returns the full pathname of the folder.
GetPossiblePermissions- Returns the set of permissions that can be applied to a folder.
GetPermission- Returns the one effective permission used to control access to the folder for the current user.
GetPermissionForGroup- Returns the one effective permission used to control access to the folder for a named group.
GetPermissionForUser- Returns the one effective permission used to control access to the folder for a named user.
GetPossiblePermissions- Returns the set of permissions that can be applied to a folder.
GetSubfolders- Returns a Folders object containing the immediate, visible subfolders
IsReadable- Indicates whether the folder content can be viewed or not.
IsWritable- Indicates whether the folder content can be modified or not.
Refresh- Refreshes the folder by discarding any cached content and reloads it on demand.
RemovePermissions- Removes folder permissions that are visible permissions on the folder.
RenameFolder- Changes the name of an existing folder.
RevertPermissions- Revert all uncommitted permission changes on the folder.
SetPermissions- Sets the permissions on the folder, replacing all visible permissions already set on the folder with those provided in the permissions argument.
SetMasterReplicaName- Sets mastership of the folder to the named replica.
SiteHasMastership- Returns True if the current site has mastership of the folder; False otherwise.