Trigger Reference of GS2-Version Script

Reference of event triggers that call extended scripts

Trigger

acceptVersion

Version approval

Synchronous Execution Script

Script and Version approval are executed synchronously in that order.

Request

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

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow version approval

Implementation Example

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

result = {
  permit=permit
}

Asynchronous Execution Script

The script executes asynchronously after the Version approval.

Request

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

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

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

result = {
}

checkVersion

Version check

Synchronous Execution Script

Script and Version check are executed synchronously in that order.

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	Required	Default	Value Limits	Description
overrideWarning	Status				Warning for overwritten version check results
overrideError	Status				Error for overwritten version check results

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
}