Class CampaignAssets

Namespace

Kentico.Xperience.Admin.DigitalMarketing.UIPages

Assembly

Kentico.Xperience.Admin.DigitalMarketing.dll

Assets tab of the campaign's edit page.

[UIEvaluatePermission("View")]
public sealed class CampaignAssets : Page<CampaignAssetsClientProperties>, IPage

Inheritance

object

Page<CampaignAssetsClientProperties>

CampaignAssets

Implements

IPage

Inherited Members

Page<CampaignAssetsClientProperties>.ValidatePage()

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

CampaignAssets(ILogger<CampaignAssets>, IUIPermissionEvaluator, IContentLanguageRetriever)

Initializes a new instance of the CampaignAssets class.

public CampaignAssets(ILogger<CampaignAssets> logger, IUIPermissionEvaluator permissionEvaluator, IContentLanguageRetriever contentLanguageRetriever)

Parameters

logger ILogger<CampaignAssets>

permissionEvaluator IUIPermissionEvaluator

contentLanguageRetriever IContentLanguageRetriever

Properties

CampaignId

ID of the campaign.

[PageParameter(typeof(IntPageModelBinder))]
public int CampaignId { get; set; }

Property Value

int

Methods

AddAssets(AddAssetsCommandArguments, CancellationToken)

Adds assets to the campaign.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse> AddAssets(AddAssetsCommandArguments arguments, CancellationToken cancellationToken)

Parameters

arguments AddAssetsCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse>

ConfigurePage()

Allows configure and share page specific values prior invocation of the ConfigureTemplateProperties(TClientProperties) or command method.

public override Task ConfigurePage()

Returns

Task

ConfigureTemplateProperties(CampaignAssetsClientProperties)

Gets the object representing client side template properties.

public override Task<CampaignAssetsClientProperties> ConfigureTemplateProperties(CampaignAssetsClientProperties properties)

Parameters

properties CampaignAssetsClientProperties

Initialized properties object.

Returns

Task<CampaignAssetsClientProperties>

GetSelection(GetSelectionCommandArguments, CancellationToken)

Returns the currently selected assets for the given asset type for preselection.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<GetSelectionCommandResult>> GetSelection(GetSelectionCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args GetSelectionCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<GetSelectionCommandResult>>

LoadData(LoadDataCommandArguments, CancellationToken)

Loads campaign assets data for the listing table.

[PageCommand(Permission = "View")]
public Task<ICommandResponse<LoadDataResult>> LoadData(LoadDataCommandArguments args, CancellationToken cancellationToken)

Parameters

args LoadDataCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadDataResult>>

LoadSidePanelData(LoadSidePanelDataCommandArguments, CancellationToken)

Loads data for the side panel listing (selectable items for the given asset type).

[PageCommand(Permission = "View")]
public Task<ICommandResponse<LoadDataResult>> LoadSidePanelData(LoadSidePanelDataCommandArguments args, CancellationToken cancellationToken = default)

Parameters

args LoadSidePanelDataCommandArguments

cancellationToken CancellationToken

Returns

Task<ICommandResponse<LoadDataResult>>

RemoveAsset(string)

Removes an asset from the campaign.

[PageCommand(Permission = "Update")]
public Task<ICommandResponse<RowActionResult>> RemoveAsset(string assetIdentifier)

Parameters

assetIdentifier string

Returns

Task<ICommandResponse<RowActionResult>>