• Preparing search index...
  • The search index is not available
型・APIリファレンス
  • 型・APIリファレンス
  • useNavigationService

Function useNavigationService

  • useNavigationService(): {
        changeLanguage: ((language) => Promise<WebApiResponse<MtpCommonResponse>>);
        changePreviewDate: ((previewDate?) => Promise<WebApiResponse<MtpCommonResponse>>);
        changeRole: ((role) => Promise<WebApiResponse<MtpCommonResponse>>);
        deleteImpersonationPermission: ((selectedList) => Promise<WebApiResponse<{
            error?: string;
        } & ImpersonationPermitListResponse>>);
        disableTimeBasedVerification: (() => Promise<WebApiResponse<MtpCommonResponse>>);
        fetchAbout: (() => Promise<WebApiResponse<{
            notice: string[];
        }>>);
        fullTextSearch: ((param) => Promise<WebApiResponse<FullTextSearchResponse>>);
        generatePersonalAccessToken: ((description) => Promise<WebApiResponse<{
            error?: string;
            token: string;
        }>>);
        getApplicationMaintenanceStatus: (() => Promise<WebApiResponse<ApplicationMaintenanceStatusResponse>>);
        getImpersonationPermitList: (() => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        getImpersonationTargetList: (() => Promise<WebApiResponse<ImpersonationTargetResponse>>);
        getPreviewDate: (() => Promise<WebApiResponse<{
            previewDate?: string;
        }>>);
        getTimeBasedSetUpInformation: (() => Promise<WebApiResponse<TimeBasedSetUpInformationResponse>>);
        getTwoStepVerificationSettingStatus: (() => Promise<WebApiResponse<{
            twoStepVerificationSettingStatus: TwoStepVerificationSettingStatus;
        }>>);
        getUserMaintenanceItem: (() => Promise<WebApiResponse<UserMaintenanceItemResponse>>);
        impersonationLogin: ((targetId) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        impersonationLogout: (() => Promise<WebApiResponse<MtpCommonResponse>>);
        insertImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        loadDefinition: ((definitionName?) => Promise<ViewInitializationDataResponse<NavigationDefinition, NavigationAdditionalResponse>>);
        revokeToken: ((param) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        setUpTimeBasedVerification: ((code) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        updateAvailableTwoStepVerification: ((isAvailableTwoStepVerification) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        updateImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        updatePassword: ((param) => Promise<WebApiResponse<{
            error?: string;
        }>>);
    }
  • NavigationのAPIを取り扱うロジックを生成します。

    Returns {
        changeLanguage: ((language) => Promise<WebApiResponse<MtpCommonResponse>>);
        changePreviewDate: ((previewDate?) => Promise<WebApiResponse<MtpCommonResponse>>);
        changeRole: ((role) => Promise<WebApiResponse<MtpCommonResponse>>);
        deleteImpersonationPermission: ((selectedList) => Promise<WebApiResponse<{
            error?: string;
        } & ImpersonationPermitListResponse>>);
        disableTimeBasedVerification: (() => Promise<WebApiResponse<MtpCommonResponse>>);
        fetchAbout: (() => Promise<WebApiResponse<{
            notice: string[];
        }>>);
        fullTextSearch: ((param) => Promise<WebApiResponse<FullTextSearchResponse>>);
        generatePersonalAccessToken: ((description) => Promise<WebApiResponse<{
            error?: string;
            token: string;
        }>>);
        getApplicationMaintenanceStatus: (() => Promise<WebApiResponse<ApplicationMaintenanceStatusResponse>>);
        getImpersonationPermitList: (() => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        getImpersonationTargetList: (() => Promise<WebApiResponse<ImpersonationTargetResponse>>);
        getPreviewDate: (() => Promise<WebApiResponse<{
            previewDate?: string;
        }>>);
        getTimeBasedSetUpInformation: (() => Promise<WebApiResponse<TimeBasedSetUpInformationResponse>>);
        getTwoStepVerificationSettingStatus: (() => Promise<WebApiResponse<{
            twoStepVerificationSettingStatus: TwoStepVerificationSettingStatus;
        }>>);
        getUserMaintenanceItem: (() => Promise<WebApiResponse<UserMaintenanceItemResponse>>);
        impersonationLogin: ((targetId) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        impersonationLogout: (() => Promise<WebApiResponse<MtpCommonResponse>>);
        insertImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        loadDefinition: ((definitionName?) => Promise<ViewInitializationDataResponse<NavigationDefinition, NavigationAdditionalResponse>>);
        revokeToken: ((param) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        setUpTimeBasedVerification: ((code) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        updateAvailableTwoStepVerification: ((isAvailableTwoStepVerification) => Promise<WebApiResponse<{
            error?: string;
        }>>);
        updateImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>);
        updatePassword: ((param) => Promise<WebApiResponse<{
            error?: string;
        }>>);
    }

    • changeLanguage: ((language) => Promise<WebApiResponse<MtpCommonResponse>>)
        • (language): Promise<WebApiResponse<MtpCommonResponse>>
        • 言語を変更します。

          Parameters

          • language: string

            新しい言語

          Returns Promise<WebApiResponse<MtpCommonResponse>>

          実行結果

    • changePreviewDate: ((previewDate?) => Promise<WebApiResponse<MtpCommonResponse>>)
        • (previewDate?): Promise<WebApiResponse<MtpCommonResponse>>
        • プレビュー日付を変更します。

          Parameters

          • Optional previewDate: string

            プレビュー日付

          Returns Promise<WebApiResponse<MtpCommonResponse>>

          実行結果

    • changeRole: ((role) => Promise<WebApiResponse<MtpCommonResponse>>)
        • (role): Promise<WebApiResponse<MtpCommonResponse>>
        • ロールを変更します。

          Parameters

          • role: string

            新しいロール

          Returns Promise<WebApiResponse<MtpCommonResponse>>

          実行結果

    • deleteImpersonationPermission: ((selectedList) => Promise<WebApiResponse<{
          error?: string;
      } & ImpersonationPermitListResponse>>)
        • (selectedList): Promise<WebApiResponse<{
              error?: string;
          } & ImpersonationPermitListResponse>>
        • 代理ログイン許可対象を削除します。

          Parameters

          • selectedList: string[]

            選択ユーザーOIDリスト

          Returns Promise<WebApiResponse<{
              error?: string;
          } & ImpersonationPermitListResponse>>

          実行結果

    • disableTimeBasedVerification: (() => Promise<WebApiResponse<MtpCommonResponse>>)
        • (): Promise<WebApiResponse<MtpCommonResponse>>
        • 時間ベース認証の無効化を行います。

          Returns Promise<WebApiResponse<MtpCommonResponse>>

          実行結果

    • fetchAbout: (() => Promise<WebApiResponse<{
          notice: string[];
      }>>)
        • (): Promise<WebApiResponse<{
              notice: string[];
          }>>
        • ライセンス条項を取得します。

          Returns Promise<WebApiResponse<{
              notice: string[];
          }>>

          ライセンス条項

    • fullTextSearch: ((param) => Promise<WebApiResponse<FullTextSearchResponse>>)
        • (param): Promise<WebApiResponse<FullTextSearchResponse>>
        • 全文検索を行います。

          Parameters

          • param: FullTextSearchParameter

            全文検索パラメータ

          Returns Promise<WebApiResponse<FullTextSearchResponse>>

          全文検索結果

    • generatePersonalAccessToken: ((description) => Promise<WebApiResponse<{
          error?: string;
          token: string;
      }>>)
        • (description): Promise<WebApiResponse<{
              error?: string;
              token: string;
          }>>
        • 個人アクセストークンを生成します。

          Parameters

          • description: string

            生成するトークンの説明

          Returns Promise<WebApiResponse<{
              error?: string;
              token: string;
          }>>

          生成されたトークン

    • getApplicationMaintenanceStatus: (() => Promise<WebApiResponse<ApplicationMaintenanceStatusResponse>>)
        • (): Promise<WebApiResponse<ApplicationMaintenanceStatusResponse>>
        • アプリケーション管理ステータスを取得します。

          Returns Promise<WebApiResponse<ApplicationMaintenanceStatusResponse>>

          アプリケーション管理ステータス

    • getImpersonationPermitList: (() => Promise<WebApiResponse<ImpersonationPermitListResponse>>)
        • (): Promise<WebApiResponse<ImpersonationPermitListResponse>>
        • 代理ログイン許可リストを取得します。

          Returns Promise<WebApiResponse<ImpersonationPermitListResponse>>

          代理ログイン許可リスト

    • getImpersonationTargetList: (() => Promise<WebApiResponse<ImpersonationTargetResponse>>)
        • (): Promise<WebApiResponse<ImpersonationTargetResponse>>
        • 代理ログイン対象リストを取得します。

          Returns Promise<WebApiResponse<ImpersonationTargetResponse>>

          代理ログイン対象リスト

    • getPreviewDate: (() => Promise<WebApiResponse<{
          previewDate?: string;
      }>>)
        • (): Promise<WebApiResponse<{
              previewDate?: string;
          }>>
        • プレビュー日付を取得します。

          Returns Promise<WebApiResponse<{
              previewDate?: string;
          }>>

          プレビュー日付

    • getTimeBasedSetUpInformation: (() => Promise<WebApiResponse<TimeBasedSetUpInformationResponse>>)
        • (): Promise<WebApiResponse<TimeBasedSetUpInformationResponse>>
        • 時間ベース認証のセットアップに必要な情報を取得します。

          Returns Promise<WebApiResponse<TimeBasedSetUpInformationResponse>>

          時間ベース認証のセットアップに必要な情報

    • getTwoStepVerificationSettingStatus: (() => Promise<WebApiResponse<{
          twoStepVerificationSettingStatus: TwoStepVerificationSettingStatus;
      }>>)
        • (): Promise<WebApiResponse<{
              twoStepVerificationSettingStatus: TwoStepVerificationSettingStatus;
          }>>
        • 2段階認証の設定ステータスを取得します。

          Returns Promise<WebApiResponse<{
              twoStepVerificationSettingStatus: TwoStepVerificationSettingStatus;
          }>>

          2段階認証の設定ステータス

    • getUserMaintenanceItem: (() => Promise<WebApiResponse<UserMaintenanceItemResponse>>)
        • (): Promise<WebApiResponse<UserMaintenanceItemResponse>>
        • ユーザーメンテナンスの設定情報を取得します。

          Returns Promise<WebApiResponse<UserMaintenanceItemResponse>>

          実行結果

    • impersonationLogin: ((targetId) => Promise<WebApiResponse<{
          error?: string;
      }>>)
        • (targetId): Promise<WebApiResponse<{
              error?: string;
          }>>
        • 代理ログインを行います。

          Parameters

          • targetId: string

            代理ログイン対象ユーザーのOID

          Returns Promise<WebApiResponse<{
              error?: string;
          }>>

          実行結果

    • impersonationLogout: (() => Promise<WebApiResponse<MtpCommonResponse>>)
        • (): Promise<WebApiResponse<MtpCommonResponse>>
        • 代理ログインを解除します。

          Returns Promise<WebApiResponse<MtpCommonResponse>>

          実行結果

    • insertImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>)
        • (param): Promise<WebApiResponse<ImpersonationPermitListResponse>>
        • 代理ログイン許可対象を追加します。

          Parameters

          • param: UpdateImpersonationPermissionParameter

            代理ログイン許可対象追加パラメータ

          Returns Promise<WebApiResponse<ImpersonationPermitListResponse>>

          実行結果

    • loadDefinition: ((definitionName?) => Promise<ViewInitializationDataResponse<NavigationDefinition, NavigationAdditionalResponse>>)
        • (definitionName?): Promise<ViewInitializationDataResponse<NavigationDefinition, NavigationAdditionalResponse>>
        • Navigation定義をロードします。

          Parameters

          • Optional definitionName: string

            定義名

          Returns Promise<ViewInitializationDataResponse<NavigationDefinition, NavigationAdditionalResponse>>

          Navigation定義

    • revokeToken: ((param) => Promise<WebApiResponse<{
          error?: string;
      }>>)
        • (param): Promise<WebApiResponse<{
              error?: string;
          }>>
        • アプリケーショントークンを削除します。

          Parameters

          • param: RevokeTokenParameter

            アプリケーショントークン削除パラメータ

          Returns Promise<WebApiResponse<{
              error?: string;
          }>>

          実行結果

    • setUpTimeBasedVerification: ((code) => Promise<WebApiResponse<{
          error?: string;
      }>>)
        • (code): Promise<WebApiResponse<{
              error?: string;
          }>>
        • 時間ベース認証のセットアップを行います。

          Parameters

          • code: string

            認証コード

          Returns Promise<WebApiResponse<{
              error?: string;
          }>>

          実行結果

    • updateAvailableTwoStepVerification: ((isAvailableTwoStepVerification) => Promise<WebApiResponse<{
          error?: string;
      }>>)
        • (isAvailableTwoStepVerification): Promise<WebApiResponse<{
              error?: string;
          }>>
        • 2段階認証設定の有効化/無効化を更新します。

          Parameters

          • isAvailableTwoStepVerification: boolean

            2段階認証を有効化するか

          Returns Promise<WebApiResponse<{
              error?: string;
          }>>

          実行結果

    • updateImpersonationPermission: ((param) => Promise<WebApiResponse<ImpersonationPermitListResponse>>)
        • (param): Promise<WebApiResponse<ImpersonationPermitListResponse>>
        • 代理ログイン許可対象を更新します。

          Parameters

          • param: UpdateImpersonationPermissionParameter

            代理ログイン許可対象更新パラメータ

          Returns Promise<WebApiResponse<ImpersonationPermitListResponse>>

          実行結果

    • updatePassword: ((param) => Promise<WebApiResponse<{
          error?: string;
      }>>)
        • (param): Promise<WebApiResponse<{
              error?: string;
          }>>
        • パスワードを更新します。

          Parameters

          • param: {
                confirmPassword: string;
                newPassword: string;
                password: string;
            }

            パスワード更新パラメータ

            • confirmPassword: string

              新しいパスワード確認

            • newPassword: string

              新しいパスワード

            • password: string

              現在のパスワード

          Returns Promise<WebApiResponse<{
              error?: string;
          }>>

          実行結果

    Example

    const { fullTextSearch } = Mdc.useNavigationService();
    fullTextSearch({
    keyword: 'キーワード',
    targetEntityNameList: ['TestEntity'],
    sortCondition: {
    entityName: '',
    sortKey: '',
    sortType: 'ASC',
    },
    }).then(({ isSuccess, data }) => {
    console.log(isSuccess);
    console.log(data.result);
    });

Settings

Member Visibility

Theme

型・APIリファレンス
  • Loading...