Managers.IPageModuleManager Interface
Namespace: Nucleus.Abstractions.Managers
Assembly: Nucleus.Abstractions.dll
Provides functions to manage database data for Models.PageModules.
Remarks
Get an instance of this class from dependency injection by including a parameter in your class constructor.
Methods
CreateNew (Site) Method
CreateNew (Site site)
Create a new Models.PageModule with default settings.
Parameters
| Name | Type |
|---|---|
| site | Nucleus.Abstractions.Models.Site |
Remarks
This method does not save the new Models.PageModule unless you call Save.
CreateNew (Site,Page) Method
CreateNew (Site site, Page page)
Create a new Models.PageModule with default settings.
Parameters
| Name | Type |
|---|---|
| site | Nucleus.Abstractions.Models.Site |
| page | Nucleus.Abstractions.Models.Page |
Remarks
This method does not save the new Models.PageModule unless you call Save.
Get (Guid) Method
Get (Guid id)
Retrieve an existing Models.PageModule from the database.
Parameters
| Name | Type |
|---|---|
| id | Guid |
CreatePermissions (Site,PageModule,Role) Method
CreatePermissions (Site site, PageModule module, Role role)
Create/add default permissions to the specified Models.PageModule for the specified Models.Role.
Parameters
| Name | Type |
|---|---|
| site | Nucleus.Abstractions.Models.Site |
| module | Nucleus.Abstractions.Models.PageModule |
| role | Nucleus.Abstractions.Models.Role |
Remarks
The new Models.Permissions are not saved unless you call SavePermissions.
SavePermissions (PageModule) Method
SavePermissions (PageModule module)
Save permissions for the specified Models.PageModule.
Parameters
| Name | Type |
|---|---|
| module | Nucleus.Abstractions.Models.PageModule |
SavePermissions (Page,PageModule) Method
SavePermissions (Page page, PageModule module)
Save permissions for the specified Models.PageModule.
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| module | Nucleus.Abstractions.Models.PageModule |
ListPermissions (PageModule) Method
ListPermissions (PageModule module)
List all permissions for the module specified by moduleId.
Parameters
| Name | Type |
|---|---|
| module | Nucleus.Abstractions.Models.PageModule |
Save (Page,PageModule) Method
Save (Page page, PageModule module)
Save the specified Models.PageModule and its ModuleSettings.
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| module | Nucleus.Abstractions.Models.PageModule |
MoveTo (Page,PageModule,String,PageModule) Method
MoveTo (Page page, PageModule module, String pane, PageModule beforeModule)
Move the specified Models.PageModule to the target pane.
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| module | Nucleus.Abstractions.Models.PageModule |
| pane | String |
| beforeModule | Nucleus.Abstractions.Models.PageModule |
SaveSettings (PageModule) Method
SaveSettings (PageModule module)
Save the settings for the specified Models.PageModule.
Parameters
| Name | Type |
|---|---|
| module | Nucleus.Abstractions.Models.PageModule |
SaveSettings (Page,PageModule) Method
SaveSettings (Page page, PageModule module)
Save the settings for the specified Models.PageModule.
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| module | Nucleus.Abstractions.Models.PageModule |
ListModulePermissionTypes
ListModulePermissionTypes ()
Return a list of available permission types, sorted by SortOrder
MoveDown (Page,Guid) Method
MoveDown (Page page, Guid moduleId)
Update the SortOrder of the page module specifed by id by swapping it with the next-highest SortOrder.
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| moduleId | Guid |
MoveUp (Page,Guid) Method
MoveUp (Page page, Guid moduleId)
Parameters
| Name | Type |
|---|---|
| page | Nucleus.Abstractions.Models.Page |
| moduleId | Guid |
Delete (Guid) Method
Delete (Guid Id)
Delete the Models.PageModule specified by Id.
Parameters
| Name | Type |
|---|---|
| Id | Guid |