CampaignEditViewModel Class

Represents View model of Campaign Info which can be serialized and used for communication between API controller and javascript services. This wrapper has to be used because info objects cannot be easily serialized and deserialized.

Inheritance Hierarchy

System.Object
  CMS.WebAnalytics.CampaignEditViewModel

Namespace: CMS.WebAnalytics
Assembly: CMS.WebAnalytics (in CMS.WebAnalytics.dll) Version: 10.0.0

Syntax

public class CampaignEditViewModel

The CampaignEditViewModel type exposes the following members.

Constructors

	Name	Description
Public method	CampaignEditViewModel()	Empty constructor. Needs to be present to enable data binding performed by the Web API.
Public method	CampaignEditViewModel(CampaignInfo, DateTime)	Constructor takes CampaignInfo and creates new instance of CampaignEditViewModel containing all values required for communication between Web API and javascript modules.

Properties

	Name	Description
Public property	CampaignID	Unique integer identifier of the campaign. Refers to the CampaignID.
Public property	CodeName	Refers to codename of the campaign. This field is required for enabling single object pinning.
Public property	Description	Campaign description used in reports, provides closer details about the campaign. Refers to the CampaignDescription.
Public property	DisplayName	Name of the campaign used in listing and all reports. Refers to the CampaignDisplayName.
Public property	SiteName	Refers to site name campaign is assigned to. This field is required for enabling single object pinning.
Public property	Status	Refers to the current status. Can be one of the CampaignStatusEnum.
Public property	UTMCode	Campaign UTM code. Refers to the CampaignUTMCode.

Methods

	Name	Description
Public method	FillCampaignInfo	Fills given campaign with data obtained from current instance of CampaignEditViewModel. This method should be used whenever the call from client to the server with filled CampaignEditViewModel was made and the incoming object values need to be copied to the existing campaign.