IAnalyticalBackend

Home > @gooddata/sdk-backend-spi > IAnalyticalBackend

IAnalyticalBackend interface

The root of the Analytical Backend SPI.

Signature:

export interface IAnalyticalBackend 

Remarks

It allows configuration related to communication with the backend and access to analytical workspaces.

The analytical backend instance MUST be immutable. Changes to configuration of the backend MUST create a new instance to work with.

Properties

Property	Type	Description
capabilities	IBackendCapabilities	Capabilities available on this backend.
config	IAnalyticalBackendConfig	Configuration used for communication with this backend.

Methods

Method	Description
authenticate(force)	Triggers authentication process against the backend.
currentUser()	Returns a service for interacting with the currently authenticated user.
deauthenticate()	Triggers deauthentication process against the backend.
entitlements()	Returns service that can be used to obtain license entitlements.
isAuthenticated()	Tests authentication against this backend.
onHostname(hostname)	Creates new instance of backend on the provided hostname.
organization(organizationId)	Returns an organization available on the backend.
organizations()	Returns a service that can be obtained to obtain organizations.
withAuthentication(provider)	Sets authentication provider to be used when backend discovers current session is not authenticated.
withTelemetry(componentName, props)	Sets telemetry information that SHOULD be sent to backend to track component usage.
workspace(id)	Returns an analytical workspace available on this backend.
workspaces()	Returns service that can be used to obtain available workspaces.