Class PromotionFilters
Filters for removing not available promotions. Used by the PromotionEngine.
Inheritance
System.Object
PromotionFilters
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Marketing
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2Syntax
public class PromotionFilters
Constructors
PromotionFilters(ICouponFilter, CampaignVisitorGroupFilter)
Initializes a new instance of PromotionFilters.
Declaration
public PromotionFilters(ICouponFilter couponFilter, CampaignVisitorGroupFilter visitorGroupFilter)
Parameters
Type | Name | Description |
---|---|---|
ICouponFilter | couponFilter | The coupon filter. |
CampaignVisitorGroupFilter | visitorGroupFilter | The service used to determine if a user can access promotion on a campaign based on the visitor groups. |
Methods
Filter(IEnumerable<PromotionData>, IEnumerable<String>, RequestFulfillmentStatus)
Filter the specified promotions, by removing those that lacks any required coupon code or any required visitor group.
Declaration
public virtual PromotionFilterContext Filter(IEnumerable<PromotionData> allPromotions, IEnumerable<string> couponCodes, RequestFulfillmentStatus requestedStatus)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<PromotionData> | allPromotions | The unfiltered list of promotions. |
System.Collections.Generic.IEnumerable<System.String> | couponCodes | Any coupon codes supplied on the order. |
RequestFulfillmentStatus | requestedStatus | The statuses to generate RewardDescriptions for. |
Returns
Type | Description |
---|---|
PromotionFilterContext | An object containing the filtered promotions, as well as some information about how the filtering was done. |