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

Function useNavigationService

  • useNavigationService(): {
        changeLanguage: (
            language: string,
        ) => Promise<WebApiResponse<MtpCommonResponse>>;
        changePreviewDate: (
            previewDate?: string,
        ) => Promise<WebApiResponse<MtpCommonResponse>>;
        changeRole: (role: string) => Promise<WebApiResponse<MtpCommonResponse>>;
        deleteImpersonationPermission: (
            selectedList: string[],
        ) => Promise<
            WebApiResponse<{ error?: string } & ImpersonationPermitListResponse>,
        >;
        disableTimeBasedVerification: () => Promise<
            WebApiResponse<MtpCommonResponse>,
        >;
        fetchAbout: () => Promise<WebApiResponse<{ notice: string[] }>>;
        fullTextSearch: (
            param: FullTextSearchParameter,
        ) => Promise<WebApiResponse<FullTextSearchResponse>>;
        generatePersonalAccessToken: (
            description: string,
        ) => 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: string,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        impersonationLogout: () => Promise<WebApiResponse<MtpCommonResponse>>;
        insertImpersonationPermission: (
            param: UpdateImpersonationPermissionParameter,
        ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>;
        loadDefinition: (
            definitionName?: string,
        ) => Promise<
            ViewInitializationDataResponse<
                NavigationDefinition,
                NavigationAdditionalResponse,
            >,
        >;
        revokeToken: (
            param: RevokeTokenParameter,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        setUpTimeBasedVerification: (
            code: string,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        updateAvailableTwoStepVerification: (
            isAvailableTwoStepVerification: boolean,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        updateImpersonationPermission: (
            param: UpdateImpersonationPermissionParameter,
        ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>;
        updatePassword: (
            param: {
                confirmPassword: string;
                newPassword: string;
                password: string;
            },
        ) => Promise<WebApiResponse<{ error?: string }>>;
    }
  • NavigationのAPIを取り扱うロジックを生成します。

    Returns {
        changeLanguage: (
            language: string,
        ) => Promise<WebApiResponse<MtpCommonResponse>>;
        changePreviewDate: (
            previewDate?: string,
        ) => Promise<WebApiResponse<MtpCommonResponse>>;
        changeRole: (role: string) => Promise<WebApiResponse<MtpCommonResponse>>;
        deleteImpersonationPermission: (
            selectedList: string[],
        ) => Promise<
            WebApiResponse<{ error?: string } & ImpersonationPermitListResponse>,
        >;
        disableTimeBasedVerification: () => Promise<
            WebApiResponse<MtpCommonResponse>,
        >;
        fetchAbout: () => Promise<WebApiResponse<{ notice: string[] }>>;
        fullTextSearch: (
            param: FullTextSearchParameter,
        ) => Promise<WebApiResponse<FullTextSearchResponse>>;
        generatePersonalAccessToken: (
            description: string,
        ) => 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: string,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        impersonationLogout: () => Promise<WebApiResponse<MtpCommonResponse>>;
        insertImpersonationPermission: (
            param: UpdateImpersonationPermissionParameter,
        ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>;
        loadDefinition: (
            definitionName?: string,
        ) => Promise<
            ViewInitializationDataResponse<
                NavigationDefinition,
                NavigationAdditionalResponse,
            >,
        >;
        revokeToken: (
            param: RevokeTokenParameter,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        setUpTimeBasedVerification: (
            code: string,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        updateAvailableTwoStepVerification: (
            isAvailableTwoStepVerification: boolean,
        ) => Promise<WebApiResponse<{ error?: string }>>;
        updateImpersonationPermission: (
            param: UpdateImpersonationPermissionParameter,
        ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>;
        updatePassword: (
            param: {
                confirmPassword: string;
                newPassword: string;
                password: string;
            },
        ) => Promise<WebApiResponse<{ error?: string }>>;
    }

    • changeLanguage: (language: string) => Promise<WebApiResponse<MtpCommonResponse>>
    • changePreviewDate: (previewDate?: string) => Promise<WebApiResponse<MtpCommonResponse>>
    • changeRole: (role: string) => Promise<WebApiResponse<MtpCommonResponse>>
    • deleteImpersonationPermission: (
          selectedList: string[],
      ) => Promise<
          WebApiResponse<{ error?: string } & ImpersonationPermitListResponse>,
      >
    • disableTimeBasedVerification: () => Promise<WebApiResponse<MtpCommonResponse>>
    • fetchAbout: () => Promise<WebApiResponse<{ notice: string[] }>>
    • fullTextSearch: (
          param: FullTextSearchParameter,
      ) => Promise<WebApiResponse<FullTextSearchResponse>>
    • generatePersonalAccessToken: (
          description: string,
      ) => 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: string) => Promise<WebApiResponse<{ error?: string }>>
    • impersonationLogout: () => Promise<WebApiResponse<MtpCommonResponse>>
    • insertImpersonationPermission: (
          param: UpdateImpersonationPermissionParameter,
      ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>
    • loadDefinition: (
          definitionName?: string,
      ) => Promise<
          ViewInitializationDataResponse<
              NavigationDefinition,
              NavigationAdditionalResponse,
          >,
      >
    • revokeToken: (param: RevokeTokenParameter) => Promise<WebApiResponse<{ error?: string }>>
    • setUpTimeBasedVerification: (code: string) => Promise<WebApiResponse<{ error?: string }>>
    • updateAvailableTwoStepVerification: (
          isAvailableTwoStepVerification: boolean,
      ) => Promise<WebApiResponse<{ error?: string }>>
    • updateImpersonationPermission: (
          param: UpdateImpersonationPermissionParameter,
      ) => Promise<WebApiResponse<ImpersonationPermitListResponse>>
    • updatePassword: (
          param: {
              confirmPassword: string;
              newPassword: string;
              password: string;
          },
      ) => 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
型・APIリファレンス
  • Loading...