User expirePoints - Revision history

Administrator: /* Example */

2019-11-22T10:22:13Z

Example

2019-11-22T10:21:39Z

Syntax

← Older revision		Revision as of 10:21, 22 November 2019
Line 6:		Line 6:
	== Syntax ==		== Syntax ==

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

	== Arguments ==		== Arguments ==

2019-11-22T10:21:20Z

2019-11-22T10:15:21Z

User_expirePoints

← Older revision		Revision as of 10:15, 22 November 2019
Line 2:		Line 2:
	= User_expirePoints =		= User_expirePoints =

			Expire all points of given users before the given time

	== Syntax ==		== Syntax ==

2019-11-22T10:14:01Z

Example

← Older revision		Revision as of 10:14, 22 November 2019
Line 19:		Line 19:

	<source lang="javascript">		<source lang="javascript">
			//Expire all points before 2019 of 2 given users
			//To see how many points will be expired, don't give Test parameter, or set Test = True
			DateTime a = new DateTime("2019/1/1");
			User_expirePoints({13848,15498936}, a , "Expire all point before 2019", true);
			//{"13848": 50, "15498936": 0}

			//To make actually expire, set Test to false
			DateTime a = new DateTime("2019/1/1");
			User_expirePoints({13848,15498936}, a , "Expire all point before 2019", false);
			//{"13848": 50, "15498936": 0}
	</source>		</source>

2019-11-22T10:06:53Z

Arguments

← Older revision		Revision as of 10:06, 22 November 2019
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 ==

2019-11-21T10:06:32Z

Return type

← Older revision		Revision as of 10:06, 21 November 2019
Line 14:		Line 14:

	== Return type ==		== Return type ==
	Dictionary		Dictionary (Dictionary of userResourceId, Amount expired)

	== Example ==		== Example ==

2019-11-21T10:05:58Z

Arguments

← Older revision		Revision as of 10:05, 21 November 2019
Line 8:		Line 8:

	== Arguments ==		== Arguments ==
			* userResourceId: array of userResourceId
			* expireAllBefore: DateTime class, points will be expired before that time
			* 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

	== Return type ==		== Return type ==

2019-11-21T09:08:18Z

Syntax

← Older revision		Revision as of 09:08, 21 November 2019
Line 5:		Line 5:
	== Syntax ==		== Syntax ==

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

	== Arguments ==		== Arguments ==

2019-11-21T08:58:57Z

Syntax

← Older revision		Revision as of 08:58, 21 November 2019
Line 5:		Line 5:
	== Syntax ==		== Syntax ==

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

	== Arguments ==		== Arguments ==