Transaction Action of GS2-JobQueue

VerifyAction

ConsumeAction

Gs2JobQueue:DeleteJobByUserId

Delete job by specifying user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
jobNamestringJob Name
timeOffsetTokenstringTime offset token
{
    "action": "Gs2JobQueue:DeleteJobByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "jobName": "[string]Job Name",
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2JobQueue:DeleteJobByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  jobName: "[string]Job Name"
  timeOffsetToken: "[string]Time offset token"
transaction.service("jobQueue").consume.delete_job_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    jobName="[string]Job Name",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2JobQueue:PushByUserId

Push jobs by specifying a user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
jobsJobEntry[]List of Jobs
timeOffsetTokenstringTime offset token
{
    "action": "Gs2JobQueue:PushByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "jobs": [
            {
                "scriptId": "[string]Script GRN",
                "args": "[string]argument",
                "maxTryCount": "[int]Maximum number of attempts"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}
action: Gs2JobQueue:PushByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  jobs: 
    - scriptId: "[string]Script GRN"
      args: "[string]argument"
      maxTryCount: "[int]Maximum number of attempts"
  timeOffsetToken: "[string]Time offset token"
transaction.service("jobQueue").acquire.push_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    jobs={
        {
            scriptId="[string]Script GRN",
            args="[string]argument",
            maxTryCount="[int]Maximum number of attempts"
        }
    },
    timeOffsetToken="[string]Time offset token",
})