Trigger Reference of GS2-Version Script

Reference for event triggers that call extended scripts, as defined in GS2-Version

acceptVersion

Event trigger to call GS2-Script before version approval.

Request

	Type	Description
namespace	Namespace	Namespace
versionModel	VersionModel	Version Model
acceptVersion	AcceptVersion	Agreed Version
currentAcceptVersion	AcceptVersion	Current Agreed Version

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow version approval

Implementation Example

namespace = args.namespace
versionModel = args.versionModel
acceptVersion = args.acceptVersion
currentAcceptVersion = args.currentAcceptVersion

result = {
  permit=permit
}

acceptVersionDone

GS2-Script called after version approval.

Request

	Type	Description
namespace	Namespace	Namespace
versionModel	VersionModel	Version Model
acceptVersion	AcceptVersion	Agreed Version

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
versionModel = args.versionModel
acceptVersion = args.acceptVersion

result = {
}

checkVersion

Event trigger to call GS2-Script when version check.

Request

	Type	Description
namespace	Namespace	Namespace
versionModel	VersionModel	Version Model
currentVersion	Version_	Current Version
userId	string	User Id
warning	Status	If the normal version check results in a warning
error	Status	If the normal version check results in an error

Result

	Type	Require	Default	Limitation	Description
overrideWarning	Status				Check Result Warning
overrideError	Status				Check Result Error

Implementation Example

namespace = args.namespace
versionModel = args.versionModel
currentVersion = args.currentVersion
userId = args.userId
warning = args.warning
error = args.error

result = {
  overrideWarning=overrideWarning,
  overrideError=overrideError
}