GS2-Inbox

Reference for event triggers that call GS2-Script

GS2-Script Reference

receiveMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

Event trigger to call GS2-Script before a message is received.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow messages to be received
overrideMetadata	string			~ 4096 chars	Metadata after overwriting

receiveMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is received.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description

readMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

Event trigger to call GS2-Script before a message is opened.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow messages to be opened

readMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is opened.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description

deleteMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

Event trigger to call GS2-Script before a message is deleted.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow message deletion

deleteMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is deleted.

	Type	Description
namespace	Namespace	Namespace
message	Message	Message

	Type	Require	Default	Limitation	Description