Transaction Action of GS2-Schedule

Specification of verify/consume/acquire transaction actions

VerifyAction

Gs2Schedule:VerifyTriggerByUserId

Verify the elapsed time since the trigger was pulled by specifying the user ID

Actions for which quantity can be specified: NO

Type Description

namespaceName string Namespace name

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

triggerName string Trigger Name

verifyType

String Enum
enum {
  “notTriggerd”,
  “elapsed”,
  “notElapsed”
]

Type of verification

Enumerator String Definition	Description
“notTriggerd”	Trigger not pulled
“elapsed”	Elapsed time
“notElapsed”	Not elapsed time

elapsedMinutes int Elapsed time (minutes)

timeOffsetToken string Time offset token

{
    "action": "Gs2Schedule:VerifyTriggerByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "triggerName": "[string]Trigger Name",
        "verifyType": "[string]Type of verification",
        "elapsedMinutes": "[int]Elapsed time (minutes)",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Schedule:VerifyTriggerByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  triggerName: "[string]Trigger Name"
  verifyType: "[string]Type of verification"
  elapsedMinutes: "[int]Elapsed time (minutes)"
  timeOffsetToken: "[string]Time offset token"

transaction.service("schedule").consume.verify_trigger_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    triggerName="[string]Trigger Name",
    verifyType="[string]Type of verification",
    elapsedMinutes="[int]Elapsed time (minutes)",
    timeOffsetToken="[string]Time offset token",
})

Gs2Schedule:VerifyEventByUserId

Verify if it is the event holding period by specifying user ID

Actions for which quantity can be specified: NO

Type Description

namespaceName string Namespace name

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

eventName string Event Type Name

verifyType

String Enum
enum {
“inSchedule”,
“notInSchedule”
]

Type of verification

Enumerator String Definition	Description
“inSchedule”	In schedule
“notInSchedule”	Not in schedule

timeOffsetToken string Time offset token

{
    "action": "Gs2Schedule:VerifyEventByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "eventName": "[string]Event Type Name",
        "verifyType": "[string]Type of verification",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Schedule:VerifyEventByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  eventName: "[string]Event Type Name"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"

transaction.service("schedule").consume.verify_event_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    eventName="[string]Event Type Name",
    verifyType="[string]Type of verification",
    timeOffsetToken="[string]Time offset token",
})

ConsumeAction

Gs2Schedule:DeleteTriggerByUserId

Delete trigger 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.
triggerName	string	Trigger Name
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Schedule:DeleteTriggerByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "triggerName": "[string]Trigger Name",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Schedule:DeleteTriggerByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  triggerName: "[string]Trigger Name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("schedule").consume.delete_trigger_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User Id",
    triggerName="[string]Trigger Name",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Schedule:TriggerByUserId

Trigger by specifying a user ID

Actions for which quantity can be specified: NO

Reversible action: YES

Type Description

namespaceName string Namespace name

triggerName string Trigger Name

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

triggerStrategy

String Enum
enum {
  “renew”,
  “extend”,
  “drop”,
  “repeatCycleEnd”,
  “repeatCycleNextStart”,
  “absoluteEnd”
]

Trigger Pulling Policy

Enumerator String Definition	Description
“renew”	Redraw with a new period if the trigger has already been pulled
“extend”	Extend the period if the trigger has already been pulled
“drop”	Ignore if the trigger has already been pulled
“repeatCycleEnd”	Trigger to expire at the end of the repeat period of the specified event
“repeatCycleNextStart”	Trigger to expire at the next repeat start date and time of the specified event
“absoluteEnd”	Trigger to expire at the end date and time of the specified event

ttl int Trigger expiration time (seconds)

eventId string Event GRN

timeOffsetToken string Time offset token

{
    "action": "Gs2Schedule:TriggerByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "triggerName": "[string]Trigger Name",
        "userId": "[string]User Id",
        "triggerStrategy": "[string]Trigger Pulling Policy",
        "ttl": "[int]Trigger expiration time (seconds)",
        "eventId": "[string]Event GRN",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Schedule:TriggerByUserId
request:
  namespaceName: "[string]Namespace name"
  triggerName: "[string]Trigger Name"
  userId: "[string]User Id"
  triggerStrategy: "[string]Trigger Pulling Policy"
  ttl: "[int]Trigger expiration time (seconds)"
  eventId: "[string]Event GRN"
  timeOffsetToken: "[string]Time offset token"

transaction.service("schedule").acquire.trigger_by_user_id({
    namespaceName="[string]Namespace name",
    triggerName="[string]Trigger Name",
    userId="[string]User Id",
    triggerStrategy="[string]Trigger Pulling Policy",
    ttl="[int]Trigger expiration time (seconds)",
    eventId="[string]Event GRN",
    timeOffsetToken="[string]Time offset token",
})

Gs2Schedule:ExtendTriggerByUserId

Extend the period of a trigger by specifying a user ID

Actions for which quantity can be specified: YES

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
triggerName	string	Trigger Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
extendSeconds	int	Trigger extension period (seconds)
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Schedule:ExtendTriggerByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "triggerName": "[string]Trigger Name",
        "userId": "[string]User Id",
        "extendSeconds": "[int]Trigger extension period (seconds)",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Schedule:ExtendTriggerByUserId
request:
  namespaceName: "[string]Namespace name"
  triggerName: "[string]Trigger Name"
  userId: "[string]User Id"
  extendSeconds: "[int]Trigger extension period (seconds)"
  timeOffsetToken: "[string]Time offset token"

transaction.service("schedule").acquire.extend_trigger_by_user_id({
    namespaceName="[string]Namespace name",
    triggerName="[string]Trigger Name",
    userId="[string]User Id",
    extendSeconds="[int]Trigger extension period (seconds)",
    timeOffsetToken="[string]Time offset token",
})