Class ServerApi

ServerApi - object-oriented interface

Export

ServerApi

Hierarchy

  • BaseAPI
    • ServerApi

Constructors

constructor

Properties

axios basePath configuration

Methods

serverListShare serverRetrieveAbout serverRetrieveAnnotationFormats serverRetrievePlugins

Constructors

constructor

  • new ServerApi(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): ServerApi

    Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns ServerApi

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

serverListShare

serverRetrieveAbout

  • serverRetrieveAbout(
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<About, any>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<About, any>>

    Throws

    Memberof

    ServerApi

serverRetrieveAnnotationFormats

  • serverRetrieveAnnotationFormats(
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<DatasetFormats, any>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<DatasetFormats, any>>

    Throws

    Memberof

    ServerApi

serverRetrievePlugins

  • serverRetrievePlugins(
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<Plugins, any>>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Plugins, any>>

    Throws

    Memberof

    ServerApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods