Function StartupApiFp

StartupApi - functional programming interface

Export

  • StartupApiFp(configuration?): {
        completeWizard(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        getFirstUser(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>;
        getFirstUser2(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>;
        getStartupConfiguration(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>)>;
        setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateStartupUser(startupUserDto?: StartupUserDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

  • Parameters

    Returns {
        completeWizard(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        getFirstUser(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>;
        getFirstUser2(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>;
        getStartupConfiguration(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>)>;
        setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        updateStartupUser(startupUserDto?: StartupUserDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • completeWizard:function
      • completeWizard(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Completes the startup wizard.

        Throws

    • getFirstUser:function
      • getFirstUser(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Gets the first user.

        Throws

    • getFirstUser2:function
      • getFirstUser2(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Gets the first user.

        Throws

    • getStartupConfiguration:function
    • setRemoteAccess:function
      • setRemoteAccess(startupRemoteAccessDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • startupRemoteAccessDto: StartupRemoteAccessDto

          The startup remote access dto.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Sets remote access and UPnP.

        Throws

    • updateInitialConfiguration:function
      • updateInitialConfiguration(startupConfigurationDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • startupConfigurationDto: StartupConfigurationDto

          The updated startup configuration.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Sets the initial startup wizard configuration.

        Throws

    • updateStartupUser:function
      • updateStartupUser(startupUserDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • OptionalstartupUserDto: StartupUserDto

          The DTO containing username and password.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Summary

        Sets the user name and password.

        Throws

Settings

Member Visibility