Class: OpenEO

OpenEO

Main class to start with openEO. Allows to connect to a server.
Source:

Methods

(static) clientVersion() → {string}

Returns the version number of the client. Not to confuse with the API version(s) supported by the client.
Source:
Returns:
Version number (according to SemVer).
Type
string

(async, static) connect(url, authTypeopt, authOptionsopt) → {Connection}

Connect to a back-end with version discovery (recommended). Includes version discovery (request to `GET /well-known/openeo`) and connects to the most suitable version compatible to this JS client version. Requests the capabilities and authenticates where required.
Parameters:
Name Type Attributes Default Description
url string The server URL to connect to.
authType string <optional>
 null Authentication type, either `basic` for HTTP Basic, `oidc` for OpenID Connect (Browser only) or `null` to disable authentication.
authOptions object <optional>
 {} Object with authentication options.
Properties
Name Type Attributes Description
username string <optional>
 HTTP Basic only: Username
password string <optional>
 HTTP Basic only: Password
clientId string <optional>
 OpenID Connect only: Your client application's identifier as registered with the OIDC provider
redirectUri string <optional>
 OpenID Connect only: The redirect URI of your client application to receive a response from the OIDC provider.
Source:
Throws:
Error
Returns:
Type
Connection

(async, static) connectDirect(url, authTypeopt, authOptionsopt) → {Connection}

Connects directly to a back-end instance, without version discovery (NOT recommended). Doesn't do version discovery, therefore a URL of a versioned API must be specified. Requests the capabilities and authenticates where required.
Parameters:
Name Type Attributes Default Description
url string The server URL to connect to.
authType string <optional>
 null Authentication type, either `basic` for HTTP Basic, `oidc` for OpenID Connect (Browser only) or `null` to disable authentication.
authOptions object <optional>
 {} Object with authentication options.
Properties
Name Type Attributes Description
username string <optional>
 HTTP Basic only: Username
password string <optional>
 HTTP Basic only: Password
clientId string <optional>
 OpenID Connect only: Your client application's identifier as registered with the OIDC provider
redirectUri string <optional>
 OpenID Connect only: The redirect URI of your client application to receive a response from the OIDC provider.
Source:
Throws:
Error
Returns:
Type
Connection