Transaction Action of GS2-Inbox

ConsumeAction

Gs2Inbox:OpenMessageByUserId

Open message with user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
messageName	string	Message Name

{
    "action": "Gs2Inbox:OpenMessageByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "messageName": "[string]Message Name"
    }
}

action: Gs2Inbox:OpenMessageByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  messageName: "[string]Message Name"

Gs2Inbox:DeleteMessageByUserId

Delete message by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
messageName	string	Message Name

{
    "action": "Gs2Inbox:DeleteMessageByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "messageName": "[string]Message Name"
    }
}

action: Gs2Inbox:DeleteMessageByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  messageName: "[string]Message Name"

AcquireAction

Gs2Inbox:SendMessageByUserId

Create a new message

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
metadata	string	Metadata corresponding to the content of the message
readAcquireActions	AcquireAction[]	Obtain actions to be performed upon opening
expiresAt	long	Datetime of ttl
expiresTimeSpan	TimeSpan_	Difference up to the expiration date of the message

{
    "action": "Gs2Inbox:SendMessageByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "metadata": "[string]Metadata corresponding to the content of the message",
        "readAcquireActions": [
            {
                "action": "[string]Types of actions to be performed in the stamp sheet",
                "request": "[string]JSON of request"
            }
        ],
        "expiresAt": "[long]Datetime of ttl",
        "expiresTimeSpan": {
            "days": "[int]Number of days from current time",
            "hours": "[int]Hours from current time",
            "minutes": "[int]Minutes from current time"
        }
    }
}

action: Gs2Inbox:SendMessageByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  metadata: "[string]Metadata corresponding to the content of the message"
  readAcquireActions: 
    - action: "[string]Types of actions to be performed in the stamp sheet"
      request: "[string]JSON of request"
  expiresAt: "[long]Datetime of ttl"
  expiresTimeSpan: 
    days: "[int]Number of days from current time"
    hours: "[int]Hours from current time"
    minutes: "[int]Minutes from current time"