Trigger Reference of GS2-Dictionary Script

Reference for event triggers that call extended scripts, as defined in GS2-Dictionary
Tags:

entry

Event trigger to call GS2-Script before entry registration.

Request

TypeDescription
namespaceNamespaceNamespace
entryModelsEntryModel[]List of Entry Models
userIdstringUser Id

Result

TypeRequireDefaultLimitationDescription
permitbool✓Allow entry registration

Implementation Example

namespace = args.namespace
entryModels = args.entryModels
userId = args.userId

result = {
  permit=permit
}

entryDone

GS2-Script called after entry registration.

Request

TypeDescription
namespaceNamespaceNamespace
entryModelsEntryModel[]List of Entry Models
userIdstringUser Id

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
entryModels = args.entryModels
userId = args.userId

result = {
}

duplicateEntry

Event trigger to call GS2-Script when GS2-Script executed when an attempt is made to re-register an entry that has already been registered..

Request

TypeDescription
namespaceNamespaceNamespace
entryModelEntryModelEntry Model
userIdstringUser Id

Result

TypeRequireDefaultLimitationDescription

Implementation Example

namespace = args.namespace
entryModel = args.entryModel
userId = args.userId

result = {
}