Click or drag to resize
RandomCodeGenerator Class
Class generating random coupon codes according to specified pattern.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceRandomCodeGenerator

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 8.2.23
Syntax
C#
public class RandomCodeGenerator

The RandomCodeGenerator type exposes the following members.

Constructors
  NameDescription
Public methodRandomCodeGenerator
Initializes new instance of RandomCodeGenerator generating random codes starting with prefix. Format of codes is specified by codePattern parameter.
Top
Methods
  NameDescription
Protected methodCodeIsUnique
Checks if given code is unique - not generated yet and accepted by CodeChecker function.
Public methodGenerateCode
Generates one new unique code. Throws exception when not able to generate unique code within 10 attempts.
Protected methodGetRandomDigit
Returns random digit 0-9.
Protected methodGetRandomChar
Returns random character A-Z.
Protected methodGetRandomNumber
Returns random number from 0 to max (exclusive).
Protected methodGetRandomSymbol
Returns random symbol 0-9 or A-Z.
Protected methodGetSymbolForType
Returns charType. Override this method to add custom character sets.
Protected methodRememberCode
Remembers given code as already generated.
Protected methodTryGenerateCode
Generates one random code.
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldStatic memberdigits
Digits 0-9.
Protected fieldStatic memberchars
Characters A-Z.
Protected fieldpattern
Pattern of generated codes. It is set via constructor.
Protected fieldprefix
Prefix of codes. This string will be added at the beginning of all generated codes.
Protected fieldStatic membersymbols
Symbols A-Z and 0-9.
Top
Properties
  NameDescription
Public propertyCodeChecker
Function returning true when its parameter represents acceptable code.
Top
See Also