ビュー
関数
executeAction

executeAction

executeAction は、アクションを実行するための関数です。アクションの識別子とパラメータを指定することで、アクションを実行できます。

コールバック関数内で複数のアクションを連続して呼びたいケースなどでご活用いただけます。

アクションの実行状態をReactアプリケーションのstateとして使用したい場合は useExecuteAction および useExecuteActionLazy の使用をおすすめします。

基本的な使い方

const App = () => {
    ...
    const [address, setAddress] = useState(null)
    const handleClick = async () => {
      const { results: getCompanyResults } = await executeAction("get-company", {
        company_id: companyId,
      })
      const companyPostalCode = getCompanyResults[0].success.postal_code
      const { results: getAddressResults } = await executeAction("get-address-from-postal-code", {
        postal_code: companyPostalCode,
      })
      setAddress(getAddressResults[0].success.address)
    }
    ...
}

詳細なインターフェース

引数

引数名説明
actionIdstring実行するアクションのID、または識別子。c3hc2ii23akg0sokf9j0, get-user
argsobjectアクションを実行するための引数で、 キーがパラメータ名、値がパラメータに渡す値のオブジェクトです。{ username: 'JohnDoe' }

なおパラメータの入力値の種類ごとにargsのプロパティの値に渡せる値の型は以下です。

入力値の種類説明
テキストstring-{ company_name: '株式会社ベースマキナ' }
数値number-{ user_id: 123 }
日付Date | string | numberstringDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。{ created: '2023-01-01', updated: new Date(), deleted: 1609459200 }
ファイルFile-{ upload_text: new File(['test'], 'test.txt', { type: 'text/plain' }) }
真偽値boolean-{ checked: true }
JSON値string | number | Date | nullJSON値の種類ごとに型が異なります。
テキストならstring | null、数値ならnumber | null、日付ならstring | number | Date | nullを渡せます。
日付の場合stringDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。 
{ company_name: '株式会社ベースマキナ', user_id: 123, created: '2023-01-01', deleted: null }
SQLstring-{ query: 'SELECT * FROM users;' }
システム値string-{ offset: '20' }
配列Array各要素の種類の型は、各入力値の種類の型と同じです。{ user_ids: [10, 11, 12] }

戻り値

プロパティ名説明
resultsArrayアクションの実行結果の配列。各要素にはsuccessfailure のプロパティが含まれます。[{"success":[{"id":1,"name":"山田太郎"}]}]