Function ServerApiFactory

  • ServerApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        serverListShare(requestParameters?, options?) => AxiosPromise<FileInfo[]>;
        serverRetrieveAbout(options?) => AxiosPromise<About>;
        serverRetrieveAnnotationFormats(options?) => AxiosPromise<DatasetFormats>;
        serverRetrievePlugins(options?) => AxiosPromise<Plugins>;
    }

    • serverListShare:function
      • Parameters

        Returns AxiosPromise<FileInfo[]>

        Summary

        Returns all files and folders that are on the server along specified path

        Throws

    • serverRetrieveAbout:function
      • Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<About>

        Summary

        Method provides basic CVAT information

        Throws

    • serverRetrieveAnnotationFormats:function
      • Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<DatasetFormats>

        Summary

        Method provides the list of supported annotations formats

        Throws

    • serverRetrievePlugins:function
      • Parameters

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<Plugins>

        Summary

        Method provides allowed plugins

        Throws

    Export

Generated using TypeDoc