Function DashboardApiFp

DashboardApi - functional programming interface

Export

  • DashboardApiFp(configuration?): {
        getConfigurationPages(enableInMainMenu?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>)>;
        getDashboardConfigurationPage(name?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    }

  • Parameters

    Returns {
        getConfigurationPages(enableInMainMenu?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>)>;
        getDashboardConfigurationPage(name?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    }

    • getConfigurationPages:function
      • getConfigurationPages(enableInMainMenu?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>)>

      • Parameters

        • OptionalenableInMainMenu: boolean

          Whether to enable in the main menu.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>)>

        Summary

        Gets the configuration pages.

        Throws

    • getDashboardConfigurationPage:function
      • getDashboardConfigurationPage(name?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

      • Parameters

        • Optionalname: string

          The name of the page.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

        Summary

        Gets a dashboard configuration page.

        Throws

Settings

Member Visibility