Trigger Reference of GS2-Inbox Script
Reference of event triggers that call extended scripts
Trigger
receiveMessage
a message is received
Synchronous Execution Script
Script and a message is received are executed synchronously in that order.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Whether to allow messages to be received | ||
| overrideMetadata | string | 0 ~ 4096 chars | Metadata after overwriting |
Implementation Example
namespace = args.namespace
message = args.message
result = {
permit=permit,
overrideMetadata=overrideMetadata
}Asynchronous Execution Script
The script will run after the a message is received is executed.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description |
|---|
Implementation Example
namespace = args.namespace
message = args.message
result = {
}readMessage
a message is opened
Synchronous Execution Script
Script and a message is opened are executed synchronously in that order.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Whether to allow messages to be opened |
Implementation Example
namespace = args.namespace
message = args.message
result = {
permit=permit
}Asynchronous Execution Script
The script will run after the a message is opened is executed.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description |
|---|
Implementation Example
namespace = args.namespace
message = args.message
result = {
}deleteMessage
a message is deleted
Synchronous Execution Script
Script and a message is deleted are executed synchronously in that order.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Whether to allow message deletion |
Implementation Example
namespace = args.namespace
message = args.message
result = {
permit=permit
}Asynchronous Execution Script
The script will run after the a message is deleted is executed.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| message | Message | Message |
Result
| Type | Required | Default | Value Limits | Description |
|---|
Implementation Example
namespace = args.namespace
message = args.message
result = {
}