Master Data Reference of GS2-Inbox
{
"version": "2020-03-12",
"globalMessages": [
{
"name": "[string]Name of message for all users",
"metadata": "[string]Metadata corresponding to the content of the message to all users",
"readAcquireActions": [
{
"action": "[string]Types of actions to be performed in the stamp sheet",
"request": "[string]JSON of request"
}
],
"expiresTimeSpan": {
"days": "[int]Number of days from current time",
"hours": "[int]Hours from current time",
"minutes": "[int]Minutes from current time"
},
"expiresAt": "[long?]Message expiration date for all users"
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2020-03-12 | Format version of master data | |||
globalMessages | List<GlobalMessage> |
GlobalMessage
Global Messages
Global messages are a mechanism for delivering messages to all game players.
Global messages can have an expiration date, and each game player can receive a global message by executing the process of receiving a global message. Unreceived global messages within the validity period are copied to your message box.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
globalMessageId | string | ✓ | ~ 1024 chars | Message GRN to all users | ||
name | string | ✓ | ~ 128 chars | Name of message for all users | ||
metadata | string | ✓ | ~ 4096 chars | Metadata corresponding to the content of the message to all users | ||
readAcquireActions | List<AcquireAction> | [] | ~ 1000 items | Acquisition actions to be performed upon opening | ||
expiresTimeSpan | TimeSpan | The period of time between receipt of a message and deletion of the message | ||||
expiresAt | long | Message expiration date for all users |
TimeSpan
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
days | int | ✓ | 0 | ~ 365 | Number of days from current time | |
hours | int | ✓ | 0 | ~ 24 | Hours from current time | |
minutes | int | ✓ | 0 | ~ 60 | Minutes from current time |
AcquireAction
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
action | enum [ ] | ✓ | ~ 128 chars | Types of actions to be performed in the stamp sheet | ||
request | string | ✓ | ~ 1048576 chars | JSON of request |