Managers.IExtensionManager Interface
Namespace: Nucleus.Abstractions.Managers
Assembly: Nucleus.Abstractions.dll
Provides management functions for extensions.
Internal Use
This interface is marked as internal use only. Internal use classes are not intended for use by extensions, and backward and forward compatibility is not guaranteed.
Fields
BACKUP_FILE_EXTENSION
Backup file extension, used for renaming dlls during upgrades.
PACKAGE_MANIFEST_FILENAME
Pacakge manifest filename
Methods
DeleteContainerDefinition (ContainerDefinition) Method
DeleteContainerDefinition (ContainerDefinition containerDefinition)
Delete a Models.ContainerDefinition database record.
Parameters
| Name | Type |
|---|---|
| containerDefinition | Nucleus.Abstractions.Models.ContainerDefinition |
DeleteControlPanelExtensionDefinition (ControlPanelExtensionDefinition) Method
DeleteControlPanelExtensionDefinition (ControlPanelExtensionDefinition controlPanelExtensionDefinition)
Delete a Models.ControlPanelExtensionDefinition database record.
Parameters
| Name | Type |
|---|---|
| controlPanelExtensionDefinition | Nucleus.Abstractions.Models.ControlPanelExtensionDefinition |
DeleteLayoutDefinition (LayoutDefinition) Method
DeleteLayoutDefinition (LayoutDefinition layoutDefinition)
Delete a Models.LayoutDefinition database record.
Parameters
| Name | Type |
|---|---|
| layoutDefinition | Nucleus.Abstractions.Models.LayoutDefinition |
DeleteModuleDefinition (ModuleDefinition) Method
DeleteModuleDefinition (ModuleDefinition moduleDefinition)
Delete a Models.ModuleDefinition database record.
Parameters
| Name | Type |
|---|---|
| moduleDefinition | Nucleus.Abstractions.Models.ModuleDefinition |
DeleteScheduledTasks (String) Method
DeleteScheduledTasks (String assemblyFilePath)
Check for and delete scheduled tasks implemented by the specified assembly.
Parameters
| Name | Type |
|---|---|
| assemblyFilePath | String |
DeleteTempFile (String) Method
DeleteTempFile (String tempFileName)
Delete the specified file from the temp folder.
Parameters
| Name | Type |
|---|---|
| tempFileName | String |
InstallExtension (String) Method
InstallExtension (String tempFileName)
Install a package, using a temp file as input.
Parameters
| Name | Type |
|---|---|
| tempFileName |
String
The file name of a zip file to install. The file must be stored in the Nucleus "Temp" folder. tempFileName must not contain a path. |
ListControlPanelExtensions (ControlPanelExtensionScopes) Method
ListControlPanelExtensions (ControlPanelExtensionScopes scope)
List installed control panel extensions.
Parameters
| Name | Type |
|---|---|
| scope | Nucleus.Abstractions.Models.ControlPanelExtensionDefinition.ControlPanelExtensionScopes |
ListPageModules (ModuleDefinition) Method
ListPageModules (ModuleDefinition moduleDefinition)
List the modules which use the specified module definition.
Parameters
| Name | Type |
|---|---|
| moduleDefinition | Nucleus.Abstractions.Models.ModuleDefinition |
SaveContainerDefinition (ContainerDefinition) Method
SaveContainerDefinition (ContainerDefinition containerDefinition)
Create or update a Models.ContainerDefinition database record.
Parameters
| Name | Type |
|---|---|
| containerDefinition | Nucleus.Abstractions.Models.ContainerDefinition |
SaveControlPanelExtensionDefinition (ControlPanelExtensionDefinition) Method
SaveControlPanelExtensionDefinition (ControlPanelExtensionDefinition controlPanelExtensionDefinition)
Create or update a Models.ControlPanelExtensionDefinition database record.
Parameters
| Name | Type |
|---|---|
| controlPanelExtensionDefinition | Nucleus.Abstractions.Models.ControlPanelExtensionDefinition |
SaveLayoutDefinition (LayoutDefinition) Method
SaveLayoutDefinition (LayoutDefinition layoutDefinition)
Create or update a Models.LayoutDefinition database record.
Parameters
| Name | Type |
|---|---|
| layoutDefinition | Nucleus.Abstractions.Models.LayoutDefinition |
SaveModuleDefinition (ModuleDefinition) Method
SaveModuleDefinition (ModuleDefinition moduleDefinition)
Create or update a Models.ModuleDefinition database record.
Parameters
| Name | Type |
|---|---|
| moduleDefinition | Nucleus.Abstractions.Models.ModuleDefinition |
SaveTempFile (Stream) Method
SaveTempFile (Stream fileStream)
Save a stream to a randomly generated filename in the temp folder.
Parameters
| Name | Type |
|---|---|
| fileStream | System.IO.Stream |
Returns
The randomly-generated file name.
UninstallExtension (Package) Method
UninstallExtension (Package package)
Uninstall the extension specified by package.
Parameters
| Name | Type |
|---|---|
| package | Nucleus.Abstractions.Models.Extensions.Package |
ValidatePackage (Stream) Method
ValidatePackage (Stream input)
Validate a package.
Parameters
| Name | Type |
|---|---|
| input |
System.IO.Stream
The file name of a zip file to install. The file must be stored in the Nucleus "Temp" folder. tempFileName must not contain a path. |
ValidatePackageContent (Stream) Method
ValidatePackageContent (Stream input)
Validate a package, skipping Nucleus version checking and "already installed" checks.
Parameters
| Name | Type |
|---|---|
| input |
System.IO.Stream
The file name of a zip file to install. The file must be stored in the Nucleus "Temp" folder. tempFileName must not contain a path. |
Remarks
This function is intended for use by the Nucleus store.