Class FolderPermissionController
Inheritance
Implements
Inherited Members
Namespace: DotNetNuke.Security.Permissions
Assembly: DotNetNuke.dll
Syntax
public class FolderPermissionController : ServiceLocator<IFolderPermissionController, FolderPermissionController>, IFolderPermissionController
Methods
| Improve this Doc View SourceCanAddFolder(FolderInfo)
Returns a flag indicating whether the current user can add a folder or file.
Declaration
public static bool CanAddFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanAdminFolder(FolderInfo)
Returns a flag indicating whether the current user can addmister a folder.
Declaration
public static bool CanAdminFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanBrowseFolder(FolderInfo)
Returns a flag indicating whether the current user can browse the folder.
Declaration
public static bool CanBrowseFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanCopyFolder(FolderInfo)
Returns a flag indicating whether the current user can copy a folder or file.
Declaration
public static bool CanCopyFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanDeleteFolder(FolderInfo)
Returns a flag indicating whether the current user can delete a folder or file.
Declaration
public static bool CanDeleteFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanManageFolder(FolderInfo)
Returns a flag indicating whether the current user can manage a folder's settings.
Declaration
public static bool CanManageFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CanViewFolder(FolderInfo)
Returns a flag indicating whether the current user can view a folder or file.
Declaration
public static bool CanViewFolder(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
CopyPermissionsToSubfolders(IFolderInfo, FolderPermissionCollection)
Copies the permissions to subfolders.
Declaration
public static void CopyPermissionsToSubfolders(IFolderInfo folder, FolderPermissionCollection newPermissions)
Parameters
Type | Name | Description |
---|---|---|
IFolderInfo | folder | The parent folder. |
FolderPermissionCollection | newPermissions | The new permissions. |
DeleteFolderPermissionsByUser(UserInfo)
Declaration
public static void DeleteFolderPermissionsByUser(UserInfo objUser)
Parameters
Type | Name | Description |
---|---|---|
UserInfo | objUser |
GetFactory()
Gets the service locator factory.
Declaration
protected override Func<IFolderPermissionController> GetFactory()
Returns
Type | Description |
---|---|
Func<IFolderPermissionController> | A factory function. |
Overrides
GetFolderPermissionsCollectionByFolder(Int32, String)
Declaration
public static FolderPermissionCollection GetFolderPermissionsCollectionByFolder(int portalID, string folder)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalID | |
System.String | folder |
Returns
Type | Description |
---|---|
FolderPermissionCollection |
HasFolderPermission(FolderPermissionCollection, String)
Declaration
public static bool HasFolderPermission(FolderPermissionCollection objFolderPermissions, string permissionKey)
Parameters
Type | Name | Description |
---|---|---|
FolderPermissionCollection | objFolderPermissions | |
System.String | permissionKey |
Returns
Type | Description |
---|---|
System.Boolean |
HasFolderPermission(Int32, String, String)
Declaration
public static bool HasFolderPermission(int portalId, string folderPath, string permissionKey)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | |
System.String | folderPath | |
System.String | permissionKey |
Returns
Type | Description |
---|---|
System.Boolean |
ImplicitRoles(Int32)
Returns a list with all roles with implicit permissions on Folders.
Declaration
public static IEnumerable<RoleInfo> ImplicitRoles(int portalId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | portalId | The Portal Id where the Roles are. |
Returns
Type | Description |
---|---|
IEnumerable<RoleInfo> | A List with the implicit roles. |
SaveFolderPermissions(FolderInfo)
SaveFolderPermissions updates a Folder's permissions.
Declaration
public static void SaveFolderPermissions(FolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
FolderInfo | folder | The Folder to update. |
SaveFolderPermissions(IFolderInfo)
SaveFolderPermissions updates a Folder's permissions.
Declaration
public static void SaveFolderPermissions(IFolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
IFolderInfo | folder | The Folder to update. |
Explicit Interface Implementations
| Improve this Doc View SourceIFolderPermissionController.CanAddFolder(IFolderInfo)
Returns a flag indicating whether the current user can add a folder or file.
Declaration
bool IFolderPermissionController.CanAddFolder(IFolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
IFolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
IFolderPermissionController.CanAdminFolder(IFolderInfo)
Returns a flag indicating whether the current user can addmister a folder.
Declaration
bool IFolderPermissionController.CanAdminFolder(IFolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
IFolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |
IFolderPermissionController.CanViewFolder(IFolderInfo)
Returns a flag indicating whether the current user can view a folder or file.
Declaration
bool IFolderPermissionController.CanViewFolder(IFolderInfo folder)
Parameters
Type | Name | Description |
---|---|---|
IFolderInfo | folder | The page. |
Returns
Type | Description |
---|---|
System.Boolean | A flag indicating whether the user has permission. |