Function ServerApiFp

Returns {
    serverListShare(directory?, search?, options?) => Promise<((axios?, basePath?) => AxiosPromise<FileInfo[]>)>;
    serverRetrieveAbout(options?) => Promise<((axios?, basePath?) => AxiosPromise<About>)>;
    serverRetrieveAnnotationFormats(options?) => Promise<((axios?, basePath?) => AxiosPromise<DatasetFormats>)>;
    serverRetrievePlugins(options?) => Promise<((axios?, basePath?) => AxiosPromise<Plugins>)>;
}

• serverListShare:function

  • serverListShare(directory?, search?, options?): Promise<((axios?, basePath?) => AxiosPromise<FileInfo[]>)>

  • Parameters

    • Optional directory: string

      Directory to browse

    • Optional search: string

      Search for specific files

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<FileInfo[]>)>

    Summary

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

    Throws

• serverRetrieveAbout:function

  • serverRetrieveAbout(options?): Promise<((axios?, basePath?) => AxiosPromise<About>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<About>)>

    Summary

    Method provides basic CVAT information

    Throws

• serverRetrieveAnnotationFormats:function

  • serverRetrieveAnnotationFormats(options?): Promise<((axios?, basePath?) => AxiosPromise<DatasetFormats>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<DatasetFormats>)>

    Summary

    Method provides the list of supported annotations formats

    Throws

• serverRetrievePlugins:function

  • serverRetrievePlugins(options?): Promise<((axios?, basePath?) => AxiosPromise<Plugins>)>

  • Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Plugins>)>

    Summary

    Method provides allowed plugins

    Throws