Interface IOutputExpansionStrategy
Defines a strategy for mapping and expanding properties in Delivery API responses.
Namespace: Umbraco.Cms.Core.DeliveryApi
Assembly: Umbraco.Core.dll
Syntax
public interface IOutputExpansionStrategy
Methods
View SourceMapContentProperties(IPublishedContent)
Maps the properties of content for the API response.
Declaration
IDictionary<string, object?> MapContentProperties(IPublishedContent content)
Parameters
| Type | Name | Description |
|---|---|---|
| IPublishedContent | content | The published content to map properties for. |
Returns
| Type | Description |
|---|---|
| IDictionary<string, object> | A dictionary of property aliases to their values. |
MapElementProperties(IPublishedElement)
Maps the properties of an element for the API response.
Declaration
IDictionary<string, object?> MapElementProperties(IPublishedElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| IPublishedElement | element | The published element to map properties for. |
Returns
| Type | Description |
|---|---|
| IDictionary<string, object> | A dictionary of property aliases to their values. |
MapMediaProperties(IPublishedContent, bool)
Maps the properties of media for the API response.
Declaration
IDictionary<string, object?> MapMediaProperties(IPublishedContent media, bool skipUmbracoProperties = true)
Parameters
| Type | Name | Description |
|---|---|---|
| IPublishedContent | media | The published media to map properties for. |
| bool | skipUmbracoProperties | Whether to skip built-in Umbraco properties that start with "umbraco". |
Returns
| Type | Description |
|---|---|
| IDictionary<string, object> | A dictionary of property aliases to their values. |