dw.campaign
Class CouponMgr
dw.campaign.CouponMgrManager to access coupons.
Constants
MR_ERROR_INVALID_SITE_ID
:
String = "MASKREDEMPTIONS_SITE_NOT_FOUND"
Indicates that an error occurred because a valid data domain cannot be found for given siteID.
Properties
coupons
:
Collection
(Read Only)
All coupons in the current site in no specific order.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
static getCouponByCode(couponCode
:
String)
:
Coupon
Tries to find a coupon for the given coupon code.
static getCoupons()
:
Collection
Returns all coupons in the current site in no specific order.
static getRedemptions(couponID
:
String, couponCode
:
String)
:
Collection
Returns list of CouponRedemptions for the specified coupon and coupon code, sorted by redemption date descending (i.e.
static maskRedemptions(siteID
:
String, email
:
String)
:
Status
Mask customer email address in coupon redemptions for the given siteID and email address
Methods inherited from class
Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Method Detail
getCoupon
Returns the coupon with the specified ID.
Parameters:
couponID
-
the coupon identifier.
Returns:
Coupon with specified ID or null
getCouponByCode
Tries to find a coupon for the given coupon code. The method first
searches for a coupon with a fixed code matching the passed value. If no
such fixed coupon is found, it searches for a coupon with a
system-generated code matching the passed value. If found, the coupon is
returned. Otherwise, the method returns null.
Parameters:
couponCode
-
The coupon code to get the coupon for.
Returns:
The coupon with the matching coupon code or null if no coupon was found.
getCoupons
static getCoupons()
:
Collection
Returns all coupons in the current site in no specific order.
Returns:
Coupons in current site
getRedemptions
Returns list of CouponRedemptions for the specified coupon and coupon code,
sorted by redemption date descending (i.e. last redemption first).
Usually, there should only either be 0 or 1 redemption. But if a coupon and code
is removed and recreated and re-issued later, there might be multiple such redemption records.
Returns an empty list if no redemption record exists in system for the specified coupon and code.
Parameters:
couponID
-
The coupon id to find redemption for.
couponCode
-
The coupon code to find redemption for.
Returns:
A sorted list of CouponRedemptions for the specified coupon and coupon code or an empty list if no redemption record exists.
© Copyright 2000-2023, salesforce.com inc. All rights reserved. Various trademarks held by their respective owners.