api:check

Version 25.3.9411


api:check


api:check キーワードは、値パラメータの有無にかかわらず使用できます。

値パラメータがない場合は、api:check のボディが実行される前に、アトリビュートがアイテムの中に存在しnull 文字列ではないことを確認します。値パラメータを指定した場合は、api:check ボディはエクスプレッションがtrue と評価された場合のみ実行します。他の値はfalse となります。評価では、大文字と小文字を区別しません。

APIScript の他のシンプルな条件文と同様に、api:else キーワードとペアで使うことができます。ただし、api:equals とは異なり、api:check はアイテムにアトリビュートが存在しない場合でも例外をスローしません。

パラメータ

  • item:アトリビュートをチェックするアイテム。アイテムが指定されていない場合は、デフォルトのアウトプットアイテムが使われます。
  • attr:チェックするアトリビュートの名前。必須です。
  • valuetrue またはfalse と評価されるエクスプレッション。例えば、true もしくはfalse を返すフォーマッタの結果です。
  • action:エクスプレッションがtrue と判断された場合に実行されるアクション。許容される値は、break およびcontinue です。

アトリビュートの制御

None

アトリビュートが設定されているかどうかを、使用する前にチェックします:

<api:check attr="_input.In_Stock">
...
</api:check>

関連項目

  • api:exists:アトリビュートが存在するかどうかをチェックする。
  • api:equals:同じ値かどうかをチェックする。
  • api:notequals:同じ値ではないかどうかをチェックする。