オブジェクト
アクションは標準のJavaScriptを記述しますが、開発にはアクション専用のオブジェクトを利用する必要があります。オブジェクトにはあらかじめプロパティが登録されている$uiや$constと任意にプロパティを追加可能な$paramや$sessionがあります。 また、REST APIのアクションでのみ使用可能な$reqや$resがあります。
オブジェクト | 目的 | 説明 |
---|---|---|
$ui | UI コンポーネントへのアクセス | 登録済みのプロパティへ値設定/取得が可能 |
$param | 次の画面へのデータ受け渡し | 任意のプロパティを設定/取得が可能 |
$session | セッション中のデータ受け渡し | 任意のプロパティを設定/取得が可能 |
$const | 定数の参照 | 登録済みの定数値を取得可能 |
$req | リクエストデータ | REST APIのアクション内でHTTPリクエストオブジェクトを取得 |
$res | レスポンスデータ | REST APIのアクション内でHTTPレスポンスオブジェクトを設定 |
Tips
$ui
$uiはアクションを定義するUIを示すオブジェクトです。UIに配置されているコンポーネントをプロパティ値として取得できます。また、アクション実行後にUIに表示されるコンポーネントの状態を示します。
アクション実行時のコンポーネント値の取得 | 例) const val = $ui.text_field_1.value; |
---|---|
アクション実行後のコンポーネント値を設定 | 例) $ui.text_field_1.value = val; |
上記は、アクション実行時にテキストフィールドの値を取得する例とアクション実行後にテキストフィールドに値を設定する例を示します。
コンポーネントは値 (value) だけではなく、color や variant などコンポーネントを装飾する内容をはじめさまざまなプロパティが存在します。それらの取得/設定について同じ方法でアクションにおいて実施することが可能です。
Tips
$this
$thisはアクションを実行している自身のコンポーネントを示すオブジェクトです。UIに配置されているコンポーネント自身のプロパティ値を取得する際に利用できます。
部品により利用できるプロパティは異なるため、アクションを実行したコンポーネントによっては存在しない可能性があります。
グローバル関数のように、アプリ内で共通で利用できる関数などでも利用いただくことが可能です。ID 「text_field_1」
のコンポーネントのアクションにて、$ui.text_field_1.valueのようにコンポーネントIDを記入せずに$thisに置き換えて利用することが可能になります。
Tips
$param
$paramは次のUI画面へ任意のデータを送るパラメータオブジェクトです。スコープは次のUI画面までです。次のように$param内に任意のプロパティを追加することができます。
$param.name = “Adam”; $param.age = 26;
送り先のUIのonload アクションにて、$paramを受け取ることができます。
const name = $param.name; const age = $param.age;
Tips
$session
$sessionはセッション中に任意のデータを管理するセッションオブジェクトです。スコープはセッション期間となります。パラメータと同様に任意のプロパティを追加・取得することができます。
Tips
セッション期間について
認証アプリケーションの場合
セッション期間は、サインイン期間中になります。
Tips
認証なしアプリケーションの場合
セッションの期間は、アプリケーションを表示してから最大24時間までとなります。
ただし、セッションの期間内であっても、ブラウザを閉じた時点で無効となります。
$global
$globalは作成したグローバル関数を参照するためのオブジェクトです。アプリケーション内で管理しているグローバル関数を利用することができます。
例)const result = await $global.myFunction()
$const
$constは登録している定数を参照するためのオブジェクトです。アプリケーション内で管理している定数名を使って、定数値を取得できます。 例)$ui.nameField.label = $const.nameLabel;
Tips
$req
$reqは、REST APIのアクション内で使用できるHTTPリクエストオブジェクトです。 $reqオブジェクトを使って、リクエストデータを取得してください。 $reqオブジェクトのプロパティについては、Amazon Gateway APIのページを参照してください。
プロパティ | 型 |
---|---|
body | string |
headers | Object |
httpMethod | string |
isBase64Encoded | boolean |
multiValueHeaders | Object |
multiValueQueryStringParameters | Object |
Path | string |
pathParameters | Object |
queryStringParameters | Object |
requestContext | Object |
resource | string |
stageVariables | Object |
$res
$resは、REST APIのアクション内で使用できるHTTPレスポンスオブジェクトです。 $resオブジェクトを使って、返却するレスポンスデータを設定してください。 $resオブジェクトのプロパティについては、Amazon Gateway APIのページを参照してください。
プロパティ | 型 |
---|---|
body | string |
headers | Object |
isBase64Encoded | boolean |
multiValueHeaders | Object |
statusCode | number |