Difference between revisions of "User expirePoints"

From Catglobe Wiki
Jump to: navigation, search
(Return type)
(Arguments)
Line 11: Line 11:
 
* expireAllBefore: DateTime class, points will be expired before that time
 
* expireAllBefore: DateTime class, points will be expired before that time
 
* Description: string  
 
* Description: string  
* Test: Boolean, optional. If false all points before input time will be expired; if True will return amount expired but doesnt actually expire
+
* Test: Boolean, optional default not set is true. If false all points before input time will be expired; if True will return amount expired but doesnt actually expire
  
 
== Return type ==
 
== Return type ==

Revision as of 12:06, 22 November 2019

User_expirePoints

Syntax

User_expirePoints(array userResourceId, CGDateTime expireAllBefore, string Description[, Boolean Test]);

Arguments

  • userResourceId: array of userResourceId
  • expireAllBefore: DateTime class, points will be expired before that time
  • Description: string
  • Test: Boolean, optional default not set is true. If false all points before input time will be expired; if True will return amount expired but doesnt actually expire

Return type

Dictionary (Dictionary of userResourceId, Amount expired)

Example