Function ServerApiAxiosParamCreator

  • ServerApi - axios parameter creator

    Parameters

    Returns {
        serverListShare: ((directory?, search?, options?) => Promise<RequestArgs>);
        serverRetrieveAbout: ((options?) => Promise<RequestArgs>);
        serverRetrieveAnnotationFormats: ((options?) => Promise<RequestArgs>);
        serverRetrievePlugins: ((options?) => Promise<RequestArgs>);
    }

    • serverListShare: ((directory?, search?, options?) => Promise<RequestArgs>)
        • (directory?, search?, options?): Promise<RequestArgs>
        • Parameters

          • Optional directory: string

            Directory to browse

          • Optional search: string

            Search for specific files

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

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

          Throws

    • serverRetrieveAbout: ((options?) => Promise<RequestArgs>)
        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method provides basic CVAT information

          Throws

    • serverRetrieveAnnotationFormats: ((options?) => Promise<RequestArgs>)
        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method provides the list of supported annotations formats

          Throws

    • serverRetrievePlugins: ((options?) => Promise<RequestArgs>)
        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method provides allowed plugins

          Throws

    Export

Generated using TypeDoc