Trigger Reference of GS2-Money2 Script

Reference of event triggers that call extended scripts

deposit

Event trigger to call GS2-Script before Deposit wallet balance.

Request

	Type	Description
namespace	Namespace	Namespace
oldWallet	Wallet	Wallet before deposit
newWallet	Wallet	Wallet after deposit
transactions	DepositTransaction[]	List of occurred transactions
count	int	Amount of balance to be added

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow wallet balance addition

Implementation Example

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
  permit=permit
}

depositDone

GS2-Script called after Deposit wallet balance.

Request

	Type	Description
namespace	Namespace	Namespace
oldWallet	Wallet	Wallet before deposit
newWallet	Wallet	Wallet after deposit
transactions	DepositTransaction[]	List of occurred transactions
count	int	Amount of balance to be added

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
}

withdraw

Event trigger to call GS2-Script before Withdraw wallet balance.

Request

	Type	Description
namespace	Namespace	Namespace
oldWallet	Wallet	Wallet before withdraw
newWallet	Wallet	Wallet after withdraw
transactions	DepositTransaction[]	List of occurred transactions
count	int	Amount of balance to be consumed

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow wallet balance addition

Implementation Example

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
  permit=permit
}

withdrawDone

GS2-Script called after Withdraw wallet balance.

Request

	Type	Description
namespace	Namespace	Namespace
oldWallet	Wallet	Wallet before withdraw
newWallet	Wallet	Wallet after withdraw
transactions	DepositTransaction[]	List of occurred transactions
count	int	Amount of balance to be consumed

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
transactions = args.transactions
count = args.count

result = {
}

Event trigger to call GS2-Script when New subscription.

Request

	Type	Description
namespace	Namespace	Namespace
contentModel	StoreSubscriptionContentModel	Store Subscription Content Model
transaction	SubscribeTransaction	Subscription Status
userId	string	User Id
ttlAt	long	Time to live for GS2-Schedule trigger

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId
ttlAt = args.ttlAt

result = {
}

renew

Event trigger to call GS2-Script when Renewal subscription.

Request

	Type	Description
namespace	Namespace	Namespace
contentModel	StoreSubscriptionContentModel	Store Subscription Content Model
transaction	SubscribeTransaction	Subscription Status
userId	string	User Id
ttlAt	long	Time to live for GS2-Schedule trigger

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId
ttlAt = args.ttlAt

result = {
}

unsubscribe

Event trigger to call GS2-Script when Unsubscribe.

Request

	Type	Description
namespace	Namespace	Namespace
contentModel	StoreSubscriptionContentModel	Store Subscription Content Model
transaction	SubscribeTransaction	Subscription Status
userId	string	User Id

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
userId = args.userId

result = {
}

takeOver

Event trigger to call GS2-Script before Take over subscription.

Request

	Type	Description
namespace	Namespace	Namespace
contentModel	StoreSubscriptionContentModel	Store Subscription Content Model
transaction	SubscribeTransaction	Subscription Status
fromUserId	string	User Id
toUserId	string	User Id
elapsedHours	int	Elapsed hours since last user change

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow subscription take over

Implementation Example

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
fromUserId = args.fromUserId
toUserId = args.toUserId
elapsedHours = args.elapsedHours

result = {
  permit=permit
}

takeOverDone

GS2-Script called after Take over subscription.

Request

	Type	Description
namespace	Namespace	Namespace
contentModel	StoreSubscriptionContentModel	Store Subscription Content Model
transaction	SubscribeTransaction	Subscription Status
fromUserId	string	User Id
toUserId	string	User Id
elapsedHours	int	Elapsed hours since last user change

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
contentModel = args.contentModel
transaction = args.transaction
fromUserId = args.fromUserId
toUserId = args.toUserId
elapsedHours = args.elapsedHours

result = {
}