NAV
GS2-Script

GS2-Inbox

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

receiveMessage

receiveMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit,
  overrideMetadata=overrideMetadata
}

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

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

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

receiveMessageDone

receiveMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is received.

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

Type Require Default Limitation Description

readMessage

readMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

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

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

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

readMessageDone

readMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is opened.

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

Type Require Default Limitation Description

deleteMessage

deleteMessage

namespace = args.namespace
message = args.message

result = {
  permit=permit
}

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

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

Type Require Default Limitation Description
permit bool Allow message deletion

deleteMessageDone

deleteMessageDone

namespace = args.namespace
message = args.message

result = {
}

GS2-Script called after a message is deleted.

Request

Type Description
namespace Namespace Namespace
message Message Message

Result

Type Require Default Limitation Description