Function PluginsApiAxiosParamCreator

PluginsApi - axios parameter creator

Export

  • PluginsApiAxiosParamCreator(configuration?): {
        disablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        enablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginImage: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginManifest: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPlugins: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uninstallPlugin: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uninstallPluginByVersion: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updatePluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        disablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        enablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginImage: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPluginManifest: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getPlugins: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uninstallPlugin: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uninstallPluginByVersion: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updatePluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • disablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Disable a plugin.

      Throws

        • (pluginId, version, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • version: string

            Plugin version.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • enablePlugin: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Enables a disabled plugin.

      Throws

        • (pluginId, version, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • version: string

            Plugin version.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets plugin configuration.

      Throws

        • (pluginId, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPluginImage: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a plugin's image.

      Throws

        • (pluginId, version, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • version: string

            Plugin version.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPluginManifest: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a plugin's manifest.

      Throws

        • (pluginId, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPlugins: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a list of currently installed plugins.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • uninstallPlugin: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Uninstalls a plugin.

      Deprecated

      Throws

        • (pluginId, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • uninstallPluginByVersion: ((pluginId: string, version: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Uninstalls a plugin by version.

      Throws

        • (pluginId, version, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • version: string

            Plugin version.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updatePluginConfiguration: ((pluginId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Accepts plugin configuration as JSON body.

      Summary

      Updates plugin configuration.

      Throws

        • (pluginId, options?): Promise<RequestArgs>

        • Parameters

          • pluginId: string

            Plugin id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility