ECommerceHelper Class

Custom E-commerce helper.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.ECommerceHelper

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

Syntax

public static class ECommerceHelper

The ECommerceHelper type exposes the following members.

Methods

	Name	Description
Public method Static member	ApplyDiscounts	Applies given discounts to specified price. Reflects discounts ordering. Discount value is calculated using discountCalculator function.
Public method Static member	DeleteOrDisable	Checks dependencies of given object and deletes it when nothing depends. Disables object otherwise. Needs EnabledColumn to be filled in TypeInfo of given object.
Public method Static member	GetAllCouponCodesQuery	Returns data query with codes in CouponCodeCode column from MultiBuyCouponCodes and CouponCodes on specified site.
Public method Static member	GetDependencyMessage	Gets the message containing list of dependencies for specified ecommerce info object.
Public method Static member	GetDiscountsTypeEnum	Converts discount type string value to DiscountTypeEnum. Default value is DiscountTypeEnum.CustomDiscount.
Public method Static member	GetDiscountTypeString	Converts DiscountTypeEnum to discount type string value.
Public method Static member	GetDiscountValue(Double, IItemDiscount, Func<Double, Double>)	Returns discount calculated from given price. Exchange rate applicator function will be applied if discount is global and flat.
Public method Static member	GetDiscountValue(Double, Double, Boolean)	Returns discount calculated from the specified price.
Public method Static member	GetSiteID	Returns 0 if specified site uses global objects based on the specified e-commerce setting, otherwise returns site ID of the specified site.
Public method Static member	GetTableColumnSum	Returns sum of all values from the specified table column.
Public method Static member	CheckMainCurrency	Checks if the site specified by the site ID has a main currency defined. Returns null if the main currency is defined, otherwise returns a warning message.
Public method Static member	IsUserAuthorizedForDepartment	Checks whether the user is authorized to access products from the specified department. Returns true if user is global admin or is granted with 'AccessAllDepartments' e-commerce module permission or he is administrator of the given department.
Public method Static member	IsUserAuthorizedForPermission(String, String, IUserInfo)	Checks the specified ecommerce permission for the given user.
Public method Static member	IsUserAuthorizedForPermission(String, String, IUserInfo, Boolean)	Checks the specified ecommerce permission for the given user.
Public method Static member	IsUserAuthorizedToModifyConfiguration(Boolean, String, IUserInfo)	Checks whether the user is authorized to modify site/global e-commerce configuration.
Public method Static member	IsUserAuthorizedToModifyConfiguration(Boolean, String, IUserInfo, Boolean)	Checks whether the user is authorized to modify site/global e-commerce configuration.
Public method Static member	SignChanged	Returns true if signs of two doubles are different.
Public method Static member	TrackAddToShoppingCartConversion(ShoppingCartItemInfo)	Tracks add to shopping cart conversion.
Public method Static member	TrackAddToShoppingCartConversion(ShoppingCartItemInfo, String)	Tracks add to shopping cart conversion.
Public method Static member	TrackOrderConversion(ShoppingCartInfo)	Tracks order conversion.
Public method Static member	TrackOrderConversion(ShoppingCartInfo, String)	Tracks order conversion.
Public method Static member	TrackOrderItemsConversions	Tracks conversions of all order items
Public method Static member	TrackRegistrationConversion(String)	Tracks registration conversion.
Public method Static member	TrackRegistrationConversion(String, String)	Tracks registration conversion.

Fields

	Name	Description
Public field Static member	ECOMMERCE_RESOURCE_NAME	Resource name for Ecommerce.