Discount Class

Facade class for MultiBuyDiscountInfo and DiscountInfo

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.Discount

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 8.2.23

Syntax

public sealed class Discount

The Discount type exposes the following members.

Constructors

	Name	Description
Public method	Discount	Initializes a new instance of the facade class.

Methods

	Name	Description
Public method	AcceptsCoupon	Indicates if given coupon code is suitable for this discount. Returns false if this discount has no codes assigned.
Public method	CreateCoupon	Creates and saves new coupon for this discount. NOTE: The uniqueness is not checked.

Operators

	Name	Description
Public operator Static member	Implicit(Discount to MultiBuyDiscountInfo)	Implicit conversion
Public operator Static member	Implicit(Discount to DiscountInfo)	Implicit conversion
Public operator Static member	Implicit(DiscountInfo to Discount)	Implicit conversion
Public operator Static member	Implicit(MultiBuyDiscountInfo to Discount)	Implicit conversion

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	CouponCodes	Returns coupon codes associated with this discount.
Public property	DiscountApplyFurtherDiscounts	Indicates that further discounts (in order of DiscountOrder) are to be processed.
Public property	DiscountCustomerRestriction	Type of discount customer restriction.
Public property	DiscountDescription	Discount description.
Public property	DiscountDisplayName	Discount display name.
Public property	DiscountEnabled	Discount enabled.
Public property	DiscountGUID	Discount GUID.
Public property	DiscountID	Discount ID.
Public property	DiscountIsFlat	True - discount value is flat, False - discount value is relative. Used for discount calculation in the shopping cart.
Public property	DiscountLastModified	Discount last modified date and time.
Public property	DiscountName	Discount name.
Public property	DiscountOrder	Order of this discount among other discounts.
Public property	DiscountRoles	Discount roles to apply discount for. Is dependable on DiscountCustomerRestriction configuration.
Public property	DiscountSiteID	Discount site ID.
Public property	DiscountStatus	Discount status.
Public property	DiscountType	Gets the type of the discount.
Public property	DiscountUsesCoupons	Indicates if this discount is applicable only with discount coupon.
Public property	DiscountValidFrom	Discount valid from.
Public property	DiscountValidTo	Discount valid to.
Public property	DiscountValue	Discount value.
Public property	HasOrUsesCoupon	Indicates if discount uses coupon or has some coupons defined.
Public property	IsRunning	Determines whether discount is currently running. ValidFrom and ValidTo properties are compared to current date/time.
Public property	IsValid	Determines whether discount is valid. Discount must be currently running and have usable coupon codes if discount uses coupons.