createReviewRequest
createReviewRequest
は、アクションのレビュー依頼を作成する関数です。
※レビュー依頼を作成するには、事前に対象のアクションにレビュー設定が必要です。
基本的な使い方
import {
createReviewRequest,
showSuccessToast,
showErrorToast,
Form,
VStack,
Box,
TextInput,
Checkbox,
DateTimePicker,
Button,
} from "@basemachina/view";
const App = () => {
const initialValues = {
// アクションの引数
message: "",
// 以下、createReviewRequest関数のオプション
redirect: true,
description: "",
neverExpires: false,
expiresIn: null,
};
const handleSubmit = async ({ values }) => {
const { message, redirect, description, neverExpires, expiresIn } = values;
try {
const { reviewRequestId } = await createReviewRequest(
// actionId
"review-test",
// args
{ message },
// options
{ redirect, description, neverExpires, expiresIn },
);
showSuccessToast(`レビュー依頼: ${reviewRequestId} を作成しました`);
} catch (err) {
showErrorToast(err.message);
}
};
return (
<Form initialValues={initialValues} onSubmit={handleSubmit}>
<VStack>
<Box>
<TextInput name="message" label="メッセージ" />
</Box>
<Box>
<TextInput name="description" label="レビューの説明" />
</Box>
<Checkbox name="redirect" label="自動でレビュー依頼に遷移する" />
<Checkbox name="neverExpires" label="レビューを無期限にする" />
<Box>
<DateTimePicker name="expiresIn" label="レビュー期限" />
</Box>
<Button type="submit" title="レビュー依頼を作成する" color="blue" />
</VStack>
</Form>
);
};
export default App;
詳細なインターフェース
引数
引数名 | 型 | 必須 ・ 任意 | 説明 | 例 |
---|---|---|---|---|
actionId | string | 必須 | 実行するアクションのID、または識別子。 | 'c3hc2ii23akg0sokf9j0' , 'get-user' |
args | object | 任意 | アクションを実行するための引数で、 キーがパラメータ名、値がパラメータに渡す値のオブジェクト。 | { username: 'JohnDoe' } |
options | object | 任意 | レビュー依頼の詳細設定。 | { description: 'レビュー依頼の説明' } |
options.description | string | 任意 | レビュー依頼の説明。最大文字数は1000文字です。 | 'レビュー依頼の説明' |
options.neverExpires | boolean | 任意 | レビュー依頼の期限を無期限に指定します。 expiresIn と同時に指定することはできません。 | true , false |
options.expiresIn | Date | string | number | 任意 | レビュー依頼の期限。string はDate 型に変換できる値、number はUnixTimestamp (秒)を入力してください。時間は過去に設定できません。また、neverExpires と同時に指定できません。 | new Date() , '2023-01-01' , 1609459200 |
options.redirect | boolean | 任意 | レビュー依頼の作成後に、自動的にレビュー依頼詳細画面へ移動する設定。 | true , false |
なおパラメータの入力値の種類ごとにargs
へ渡せる値の型は以下です。
入力値の種類 | 型 | 説明 | 例 |
---|---|---|---|
テキスト | string | - | { company_name: '株式会社ベースマキナ' } |
数値 | number | null | - | { user_id: 123 } |
日付 | Date | string | number | null | string はDate 型に変換できる値、number はUnixTimestamp (秒)を入力してください。 | { created: '2023-01-01', updated: new Date(), deleted: 1609459200 } |
ファイル | File | null | - | { upload_text: new File(['test'], 'test.txt', { type: 'text/plain' }) } |
真偽値 | boolean | - | { checked: true } |
JSON値 | string | number | Date | null | JSON値の種類ごとに型が異なります。 テキストなら string | null 、数値ならnumber | null 、日付ならstring | number | Date | null を渡せます。日付の場合 string はDate 型に変換できる値、number はUnixTimestamp (秒)を入力してください。 | { company_name: '株式会社ベースマキナ', user_id: 123, created: '2023-01-01', deleted: null } |
SQL | string | - | { query: 'SELECT * FROM users;' } |
システム値 | string | - | { offset: '20' } |
配列 | Array | 各要素の種類の型は、各入力値の種類の型と同じです。 | { user_ids: [10, 11, 12] } |
タプル | Array | 各要素の種類の型は、各入力値の種類の型と同じです。 | { id_and_name: [123, 'taro'] } |
戻り値
プロパティ名 | 型 | 説明 | 例 |
---|---|---|---|
reviewRequestId | string | 作成したレビュー依頼のID。 | cpt8gkab5gv1ibk8r5h0 |