Table of Contents

Class PackageController

Namespace
Umbraco.Cms.Web.BackOffice.Controllers
Assembly
Umbraco.Web.BackOffice.dll

A controller used for managing packages in the back office

[Authorize(Policy = "SectionAccessPackages")]
public class PackageController : UmbracoAuthorizedJsonController
Inheritance
PackageController
Inherited Members

Constructors

PackageController(IPackagingService, IBackOfficeSecurityAccessor, PackageMigrationRunner, ILogger<PackageController>)

public PackageController(IPackagingService packagingService, IBackOfficeSecurityAccessor backofficeSecurityAccessor, PackageMigrationRunner packageMigrationRunner, ILogger<PackageController> logger)

Parameters

packagingService IPackagingService
backofficeSecurityAccessor IBackOfficeSecurityAccessor
packageMigrationRunner PackageMigrationRunner
logger ILogger<PackageController>

Methods

DeleteCreatedPackage(int)

Deletes a created package

[HttpPost]
[HttpDelete]
public IActionResult DeleteCreatedPackage(int packageId)

Parameters

packageId int

Returns

IActionResult

DownloadCreatedPackage(int)

[HttpGet]
public IActionResult DownloadCreatedPackage(int id)

Parameters

id int

Returns

IActionResult

GetCreatedPackageById(int)

public ActionResult<PackageDefinition> GetCreatedPackageById(int id)

Parameters

id int

Returns

ActionResult<PackageDefinition>

GetCreatedPackages()

public IEnumerable<PackageDefinition> GetCreatedPackages()

Returns

IEnumerable<PackageDefinition>

GetEmpty()

public PackageDefinition GetEmpty()

Returns

PackageDefinition

GetInstalled()

Returns all installed packages - only shows their latest versions

public IEnumerable<InstalledPackage> GetInstalled()

Returns

IEnumerable<InstalledPackage>

GetInstalledPackageByName(string)

public ActionResult<InstalledPackage> GetInstalledPackageByName(string packageName)

Parameters

packageName string

Returns

ActionResult<InstalledPackage>

PostSavePackage(PackageDefinition)

Creates or updates a package

public ActionResult<PackageDefinition> PostSavePackage(PackageDefinition model)

Parameters

model PackageDefinition

Returns

ActionResult<PackageDefinition>

RunMigrations(string)

[HttpPost]
public ActionResult<IEnumerable<InstalledPackage>> RunMigrations(string packageName)

Parameters

packageName string

Returns

ActionResult<IEnumerable<InstalledPackage>>