Transaction Action of GS2-Dictionary

Specification of verify/consume/acquire transaction actions

VerifyAction

Gs2Dictionary:VerifyEntryByUserId

Verify entry by specifying a user ID

Whether the action allows quantity specification: NO

Type Condition Required Default Value Limits Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

userId

string

✓

~ 128 chars

User ID
Set #{userId} to replace the currently logged in user ID.

entryModelName

string

✓

~ 128 chars

Entry Model Name

Entry model-specific name. Specified using alphanumeric characters, hyphen (-), underscore (_), and period (.).

verifyType

String Enum
enum {
“havent”,
“have”
}

✓

Type of verification

Enumerator String Definition	Description
“havent”	The specified entry must not be held
“have”	The specified entry must be held

timeOffsetToken string ~ 1024 chars Time offset token

{
    "action": "Gs2Dictionary:VerifyEntryByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "entryModelName": "[string]Entry Model Name",
        "verifyType": "[string]Type of verification",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Dictionary:VerifyEntryByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  entryModelName: "[string]Entry Model Name"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"

transaction.service("dictionary").verify.verify_entry_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    entryModelName="[string]Entry Model Name",
    verifyType="[string]Type of verification",
    timeOffsetToken="[string]Time offset token",
})

ConsumeAction

Gs2Dictionary:DeleteEntriesByUserId

Delete entries by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: YES

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
entryModelNames	List<string>		[]	0 ~ 100 items	List of Entry Model Names
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Dictionary:DeleteEntriesByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "entryModelNames": [
            "[string]Entry Model Name"
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Dictionary:DeleteEntriesByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  entryModelNames: 
  - "[string]Entry Model Name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("dictionary").consume.delete_entries_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    entryModelNames={
        "[string]Entry Model Name"
    },
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Dictionary:AddEntriesByUserId

Add entries by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: YES

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
entryModelNames	List<string>		[]	0 ~ 100 items	List of Entry Model Names
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Dictionary:AddEntriesByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "entryModelNames": [
            "[string]Entry Model Name"
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Dictionary:AddEntriesByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  entryModelNames: 
    - "[string]Entry Model Name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("dictionary").acquire.add_entries_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    entryModelNames={
        "[string]Entry Model Name"
    },
    timeOffsetToken="[string]Time offset token",
})