Skip to Content
ビューコードエディター関数getActionJobResult

getActionJobResult

getActionJobResult は、ジョブの結果を取得する関数です。

基本的な使い方

import { useCallback, useState } from "react";
import {
  getActionJobResult,
  showErrorToast,
  Form,
  VStack,
  Box,
  TextInput,
  Button,
  Heading,
} from "@basemachina/view";
 
const App = () => {
  const [jobResult, setJobResult] = useState();
  const handleSubmit = async ({ values }) => {
    const { actionJobId } = values;
    try {
      const jobResult = await getActionJobResult(actionJobId);
      setJobResult(jobResult);
    } catch (err) {
      showErrorToast(err.message);
    }
  };
 
  return (
    <>
      <Form onSubmit={handleSubmit}>
        <VStack>
          <Box>
            <TextInput name="actionJobId" label="ジョブID" />
          </Box>
          <Button type="submit" title="ジョブの結果を取得する" color="blue" />
        </VStack>
      </Form>
      <VStack>
        <Heading text="ジョブの結果" />
        <pre>{JSON.stringify(jobResult, null, 2)}</pre>
      </VStack>
    </>
  );
};
 
export default App;

詳細なインターフェース

引数

引数名型必須 ・ 任意説明例
actionJobIdstring必須結果を取得するジョブのID。ジョブのIDは、ジョブの詳細ページのURL末尾か、createActionJob関数の戻り値から取得できます。'c3hc2ii23akg0sokf9j0'

戻り値

プロパティ名型説明例
resultsArrayジョブの結果の配列。形式はアクションの実行結果と同じです。配列の各要素は、success と failure のプロパティを持ちます。[{"success":[{"id":1,"name":"山田太郎"}]}]
byteSizenumber結果のバイトサイズ。大きすぎるジョブの結果を画面表示に使うかどうかの分岐などに使うことができます。126

エラー

以下の条件に該当する場合、getActionJobResultはエラーをthrowします。try...catchで適切にハンドリングしてください。

条件エラーメッセージ
ジョブが完了していない場合ジョブが完了していないため、結果を取得できませんでした。
ジョブがキャンセルされた場合ジョブがキャンセルされたため、結果を取得できませんでした。
ジョブの閲覧権限がない場合ジョブの閲覧権限がないため、結果を取得できませんでした。
createActionJobcreateReviewRequest