Table of Contents

Class PathRegistration

Namespace
CMS.IO
Assembly
CMS.IO.dll

Represents a registered file system path with its type and metadata.

public sealed class PathRegistration
Inheritance
object
PathRegistration
Extension Methods

Remarks

A registration describes path intent and deployment metadata that can be interpreted by higher-level mapping modules. It intentionally does not enforce any specific storage provider.

Use RegisterPath(string, PathType) to create registrations from a module, or AddStoragePathRegistration(IServiceCollection, string, PathType) to register paths during application startup via Microsoft.Extensions.DependencyInjection.IServiceCollection.

Properties

MappedPath

Gets the mapped physical path.

public string MappedPath { get; }

Property Value

string

PathType

Gets the type of the path.

public PathType PathType { get; }

Property Value

PathType

RegisteredPath

Gets the originally registered path as provided to the API.

public string RegisteredPath { get; }

Property Value

string

RequiresLocalMappingForDeployment

Gets a value indicating whether this path requires local deployment packaging.

public bool RequiresLocalMappingForDeployment { get; }

Property Value

bool

Remarks

This flag is set by internal platform modules for paths whose binary content cannot travel through any automated pipeline (CI/CD or content synchronization). The primary example is media library files: unlike content items or configuration objects, media binaries are not serialized into the CD repository and must be explicitly collected from local development artifacts and packaged for transfer to the target environment.

Customer-registered paths always have this property set to false.

Use this flag in custom mapping modules to identify paths that require special local packaging handling.