GS2-Schedule トランザクションアクション

検証/消費/入手の各トランザクションアクションの仕様

VerifyAction

検証アクション

Gs2Schedule:VerifyTriggerByUserId

ユーザーIDを指定してトリガーが引かれてからの経過時間を検証

数量指定可能なアクション：いいえ

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
triggerName	string	トリガーの名前
verifyType	enum [ “notTriggerd”, “elapsed”, “notElapsed” ]	検証の種類
elapsedMinutes	int	経過時間(分)
timeOffsetToken	string	タイムオフセットトークン

verifyType に指定する列挙型の定義

定義	説明
notTriggerd	トリガーが引かれていない
elapsed	指定時間が経過している
notElapsed	指定時間が経過していない

{
    "action": "Gs2Schedule:VerifyTriggerByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "triggerName": "[string]トリガーの名前",
        "verifyType": "[string]検証の種類",
        "elapsedMinutes": "[int]経過時間(分)",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Schedule:VerifyTriggerByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  triggerName: "[string]トリガーの名前"
  verifyType: "[string]検証の種類"
  elapsedMinutes: "[int]経過時間(分)"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("schedule").consume.verify_trigger_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    triggerName="[string]トリガーの名前",
    verifyType="[string]検証の種類",
    elapsedMinutes="[int]経過時間(分)",
    timeOffsetToken="[string]タイムオフセットトークン",
})

Gs2Schedule:VerifyEventByUserId

ユーザーIDを指定してイベントの開催期間であるかを検証

数量指定可能なアクション：いいえ

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
eventName	string	イベントの種類名
verifyType	enum [ “inSchedule”, “notInSchedule” ]	検証の種類
timeOffsetToken	string	タイムオフセットトークン

verifyType に指定する列挙型の定義

定義	説明
inSchedule	イベントの開催期間である
notInSchedule	イベントの開催期間ではない

{
    "action": "Gs2Schedule:VerifyEventByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "eventName": "[string]イベントの種類名",
        "verifyType": "[string]検証の種類",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Schedule:VerifyEventByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  eventName: "[string]イベントの種類名"
  verifyType: "[string]検証の種類"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("schedule").consume.verify_event_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    eventName="[string]イベントの種類名",
    verifyType="[string]検証の種類",
    timeOffsetToken="[string]タイムオフセットトークン",
})

ConsumeAction

消費アクション

Gs2Schedule:DeleteTriggerByUserId

ユーザIDを指定してトリガーを削除

数量指定可能なアクション：いいえ

反転可能なアクション：いいえ

	型	説明
namespaceName	string	ネームスペース名
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
triggerName	string	トリガーの名前
timeOffsetToken	string	タイムオフセットトークン

{
    "action": "Gs2Schedule:DeleteTriggerByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "userId": "[string]ユーザーID",
        "triggerName": "[string]トリガーの名前",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Schedule:DeleteTriggerByUserId
request:
  namespaceName: "[string]ネームスペース名"
  userId: "[string]ユーザーID"
  triggerName: "[string]トリガーの名前"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("schedule").consume.delete_trigger_by_user_id({
    namespaceName="[string]ネームスペース名",
    userId="[string]ユーザーID",
    triggerName="[string]トリガーの名前",
    timeOffsetToken="[string]タイムオフセットトークン",
})

AcquireAction

入手アクション

Gs2Schedule:TriggerByUserId

ユーザIDを指定してトリガーを実行

数量指定可能なアクション：いいえ

反転可能なアクション：はい

	型	説明
namespaceName	string	ネームスペース名
triggerName	string	トリガーの名前
userId	string	`#{userId}` と設定することでログイン中のユーザーIDに置換されます
triggerStrategy	enum [ “renew”, “extend”, “drop”, “repeatCycleEnd”, “repeatCycleNextStart”, “absoluteEnd” ]	トリガーの引き方の方針
ttl	int	トリガーの有効期限(秒)
eventId	string	イベントGRN
timeOffsetToken	string	タイムオフセットトークン

triggerStrategy に指定する列挙型の定義

定義	説明
renew	すでにトリガーが引かれている場合は再度新しい期間で引き直す
extend	すでにトリガーが引かれている場合は期間を延長
drop	すでにトリガーが引かれている場合は無視
repeatCycleEnd	指定したイベントの繰り返し期間の終了日時に有効期限を迎えるようにトリガーを引く
repeatCycleNextStart	指定したイベントの繰り返しで、次回の繰り返し開始日時に有効期限を迎えるようにトリガーを引く
absoluteEnd	指定したイベントの終了日時に有効期限を迎えるようにトリガーを引く

{
    "action": "Gs2Schedule:TriggerByUserId",
    "request": {
        "namespaceName": "[string]ネームスペース名",
        "triggerName": "[string]トリガーの名前",
        "userId": "[string]ユーザーID",
        "triggerStrategy": "[string]トリガーの引き方の方針",
        "ttl": "[int]トリガーの有効期限(秒)",
        "eventId": "[string]イベントGRN",
        "timeOffsetToken": "[string]タイムオフセットトークン"
    }
}

action: Gs2Schedule:TriggerByUserId
request:
  namespaceName: "[string]ネームスペース名"
  triggerName: "[string]トリガーの名前"
  userId: "[string]ユーザーID"
  triggerStrategy: "[string]トリガーの引き方の方針"
  ttl: "[int]トリガーの有効期限(秒)"
  eventId: "[string]イベントGRN"
  timeOffsetToken: "[string]タイムオフセットトークン"

transaction.service("schedule").acquire.trigger_by_user_id({
    namespaceName="[string]ネームスペース名",
    triggerName="[string]トリガーの名前",
    userId="[string]ユーザーID",
    triggerStrategy="[string]トリガーの引き方の方針",
    ttl="[int]トリガーの有効期限(秒)",
    eventId="[string]イベントGRN",
    timeOffsetToken="[string]タイムオフセットトークン",
})