Class LoyaltyService
- Namespace
- Dynamicweb.Ecommerce.Loyalty
- Assembly
- Dynamicweb.Ecommerce.dll
public class LoyaltyService : ICacheStorage<int, Reward>, ICacheStorage<int>, ICacheStorage
- Inheritance
-
LoyaltyService
- Implements
- Inherited Members
Properties
AllowEarnPointsFromPurchasedPoints
Gets the value indicating wheither the buying items with points should earn more points.
public bool AllowEarnPointsFromPurchasedPoints { get; }
Property Value
Methods
ClearCache()
Resets all keys to the default value for objects stored in the object cache
public void ClearCache()
ClearCache(IEnumerable<int>)
Resets the specified keys to the default value for objects stored in the object cache
public void ClearCache(IEnumerable<int> keys)
Parameters
keys
IEnumerable<int>Keys to reset
ClearCache(int)
Resets the specified key to the default value for objects stored in the object cache
public void ClearCache(int key)
Parameters
key
intKey to reset
ClearRewardRuleCache()
Remove all reward rules from cache.
public void ClearRewardRuleCache()
ClearUserTransactionCache(int)
Remove user transactions from cache.
public void ClearUserTransactionCache(int userId)
Parameters
userId
int
CreateTransaction(UserTransaction)
Creates the user transaction
public void CreateTransaction(UserTransaction transaction)
Parameters
transaction
UserTransactionThe UserTransaction.
CreateTransaction(UserTransaction, OrderLine)
Creates the user transaction
public void CreateTransaction(UserTransaction transaction, OrderLine orderLine)
Parameters
transaction
UserTransactionThe UserTransaction.
orderLine
OrderLineThe OrderLine.
CreateTransaction(UserTransaction, User)
Creates the user transaction
public void CreateTransaction(UserTransaction transaction, User user)
Parameters
transaction
UserTransactionThe UserTransaction.
user
UserThe User.
DeleteReward(Reward)
Deletes the reward.
public void DeleteReward(Reward reward)
Parameters
reward
Reward
DeleteRewardRule(RewardRule)
Deletes the instance.
public void DeleteRewardRule(RewardRule rewardRule)
Parameters
rewardRule
RewardRule
FindPoints(OrderLine)
Finds the points.
public IPointInfo FindPoints(OrderLine orderLine)
Parameters
orderLine
OrderLineThe order line.
Returns
- IPointInfo
The IPointInfo.
FindPoints(Product, Order, DateTime)
Finds the points.
public ConditionPointInfo FindPoints(Product product, Order order, DateTime orderTime)
Parameters
Returns
FindPoints(Product, Order, DateTime, string)
Finds the points.
public ConditionPointInfo FindPoints(Product product, Order order, DateTime orderTime, string unitId)
Parameters
product
ProductThe product.
order
OrderThe order.
orderTime
DateTimeThe order time.
unitId
stringThe unit ID.
Returns
GetPointsBalance(User)
Gets the transaction balance for user.
public double GetPointsBalance(User user)
Parameters
Returns
GetPointsBalance(int)
Gets the transaction balance by user id.
public double GetPointsBalance(int userId)
Parameters
userId
intThe user id.
Returns
GetRewardById(int)
Gets reward by ID.
public Reward GetRewardById(int rewardId)
Parameters
rewardId
intThe reward id.
Returns
- Reward
The reward.
GetRewardRule(int, int)
Gets the reward rule.
public RewardRule GetRewardRule(int rewardId, int id)
Parameters
Returns
- RewardRule
The RewardRule.
GetRewardUsageCount(Reward)
Gets the count of the reward usage.
public int GetRewardUsageCount(Reward reward)
Parameters
reward
Reward
Returns
- int
Number of the reward usage.
GetRewards()
Return all rewards.
public IEnumerable<Reward> GetRewards()
Returns
GetRewardsGiven(IEnumerable<Reward>)
Gets the points given for the specified list of rewards.
public IEnumerable<RewardPointsGiven> GetRewardsGiven(IEnumerable<Reward> rewards)
Parameters
rewards
IEnumerable<Reward>The rewards.
Returns
- IEnumerable<RewardPointsGiven>
IEnumerable(Of RewardPointsGiven).
GetRulesForReward(int)
Gets rules for the reward id.
public IEnumerable<RewardRule> GetRulesForReward(int rewardId)
Parameters
rewardId
intThe reward id.
Returns
GetTotalPoints(Reward, double, double, double)
Gets the total points.
public double GetTotalPoints(Reward reward, double productsPrice, double productsCount, double divisor)
Parameters
reward
RewardproductsPrice
doubleThe products price.
productsCount
doubleThe products count.
divisor
doubleThe divisor.
Returns
- double
The total points.
GetUserTransactions(int)
Gets the collection of the user transactions by user id.
public IEnumerable<UserTransaction> GetUserTransactions(int userId)
Parameters
userId
intThe user id.
Returns
LoadRewardsFromUserTransaction(IEnumerable<UserTransaction>)
Loads the rewards from the user transaction collection.
public void LoadRewardsFromUserTransaction(IEnumerable<UserTransaction> userTransactions)
Parameters
userTransactions
IEnumerable<UserTransaction>The collection of user transactions.
RedeemExpiredPoints()
public void RedeemExpiredPoints()
RedeemPoints(Order)
Redeem points from Order.
public void RedeemPoints(Order order)
Parameters
RedeemPoints(double, string, int)
Redeem points.
public void RedeemPoints(double points, string comment, int userId)
Parameters
points
doubleThe number of points.
comment
stringThe comment for transaction.
userId
intThe user id.
RedeemPoints(double, string, int, DateTime)
Redeem points.
public void RedeemPoints(double points, string comment, int userId, DateTime transactionDate)
Parameters
points
doubleThe number of points.
comment
stringThe comment for transaction.
userId
intThe user id.
transactionDate
DateTimeThe transaction date.
RedeemPoints(double, string, int, DateTime, TransactionObjectType, string)
public void RedeemPoints(double points, string comment, int userId, DateTime transactionDate, TransactionObjectType transactionType, string transactionElement)
Parameters
points
doublecomment
stringuserId
inttransactionDate
DateTimetransactionType
TransactionObjectTypetransactionElement
string
RewardPoints(Order)
Reward points from order lines on an order.
public void RewardPoints(Order order)
Parameters
order
OrderThe order.
RewardPoints(double, string, int)
Reward points.
public void RewardPoints(double points, string comment, int userId)
Parameters
points
doubleThe number of points.
comment
stringThe comment for transaction.
userId
intThe user id.
SaveReward(Reward)
Saves current reward to the database.
public void SaveReward(Reward reward)
Parameters
reward
Reward
SaveRewardRule(RewardRule)
Saves the instance to the data base.
public void SaveRewardRule(RewardRule rewardRule)
Parameters
rewardRule
RewardRule
TryUpdateRewards(Order)
Tries to update rewards.
public void TryUpdateRewards(Order order)
Parameters
order
OrderThe order.
UsePoints(Order)
Redeem points from Order and exchange points in case of Loyalty discount is used.
public void UsePoints(Order order)