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 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.

triggerName

string

✓

~ 128 chars

Trigger Name

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

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

{verifyType} in [“elapsed”, “notElapsed”]

✓*

0 ~ 2147483646

Elapsed time (minutes)

* Required if verifyType is “elapsed”,“notElapsed”

timeOffsetToken string ~ 1024 chars 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").verify.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 whether the Event is active 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.

eventName

string

✓

~ 128 chars

Event Name

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

verifyType

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

✓

Type of verification

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

timeOffsetToken string ~ 1024 chars Time offset token

{
    "action": "Gs2Schedule:VerifyEventByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "eventName": "[string]Event 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 Name"
  verifyType: "[string]Type of verification"
  timeOffsetToken: "[string]Time offset token"

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

ConsumeAction

Gs2Schedule:DeleteTriggerByUserId

Delete Trigger by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	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.
triggerName	string	✓	~ 128 chars	Trigger Name Trigger-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
timeOffsetToken	string		~ 1024 chars	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

Execute the Trigger by specifying a user ID

Whether the action allows quantity specification: NO

Whether the action is reversible: YES

Type Condition Required Default Value Limits Description

namespaceName

string

✓

~ 128 chars

Namespace name

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

triggerName

string

✓

~ 128 chars

Trigger Name

Trigger-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.

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

{triggerStrategy} in [“renew”, “extend”, “drop”]

✓*

0 ~ 2147483646

Trigger expiration time (seconds)

* Required if triggerStrategy is “renew”,“extend”,“drop”

eventId

string

{triggerStrategy} in [“repeatCycleEnd”, “repeatCycleNextStart”, “absoluteEnd”]

✓*

~ 1024 chars

Event GRN

* Required if triggerStrategy is “repeatCycleEnd”,“repeatCycleNextStart”,“absoluteEnd”

timeOffsetToken string ~ 1024 chars 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

Whether the action allows quantity specification: YES

Whether the action is reversible: NO

	Type	Required	Value Limits	Description
namespaceName	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
triggerName	string	✓	~ 128 chars	Trigger Name Trigger-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.
extendSeconds	int	✓	0 ~ 2147483646	Trigger extension period (seconds)
timeOffsetToken	string		~ 1024 chars	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",
})