Trigger Reference of GS2-Inbox Script

receiveMessage

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

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

receiveMessageDone

GS2-Script called after a message is received.

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
}

readMessage

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

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

readMessageDone

GS2-Script called after a message is opened.

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
}

deleteMessage

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

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

deleteMessageDone

GS2-Script called after a message is deleted.

Request

Result

Implementation Example

namespace = args.namespace
message = args.message

result = {
}