Class: xFrameDriver

This class represents the SDK driver used by external applications. This class extends the EventEmitter and implements the JsSDK interface.

Implements

JsSDK

Hierarchy

• EventEmitter

  ↳ xFrameDriver

Implements

• JsSDK

Table of contents

Constructors

• constructor

Properties

• agent
• projects
• annotations
• items
• settings
• recipes
• ontologies
• labels
• attributes
• structures
• tasks
• contributors
• datasets
• executions
• drivers
• integrations
• pipelines
• navigator

Methods

• init
• sendEvent

Accessors

• logger

Constructors

constructor

• new xFrameDriver()

Inherited from

EventEmitter.constructor

Properties

agent

• agent: PeerAgent

The application's agent.

projects

• projects: Projects

The Projects repository. It is used to access Project related CRUD methods.

Implementation of

JsSDK.projects

annotations

• annotations: Annotations

The Annotations repository. It is used to access Annotation related CRUD methods.

Implementation of

JsSDK.annotations

items

• items: Items

The Items repository. It is used to access Item related CRUD methods.

Implementation of

JsSDK.items

settings

• settings: AppSettings

The Settings repository. It is used to access Settings related CRUD methods.

Implementation of

JsSDK.settings

recipes

• recipes: Recipes

The Recipes repository. It is used to access Recipe related CRUD methods.

Implementation of

JsSDK.recipes

ontologies

• ontologies: Ontologies

The Ontologies repository. It is used to access Ontology related CRUD methods.

Implementation of

JsSDK.ontologies

labels

• labels: Labels

The Labels repository. It is used to access Label related CRUD methods.

Implementation of

JsSDK.labels

attributes

• attributes: Attributes

The Attributes repository. It is used to access Attribute related CRUD methods.

Implementation of

JsSDK.attributes

structures

• structures: Structures

The Structures repository. It is used to access Structure related CRUD methods.

Implementation of

JsSDK.structures

tasks

• tasks: Tasks

The Tasks repository. It is used to access Task related CRUD methods.

Implementation of

JsSDK.tasks

contributors

• contributors: Contributors

The Contributors repository. It is used to access Contributor related CRUD methods.

Implementation of

JsSDK.contributors

datasets

• datasets: Datasets

The Datasets repository. It is used to access Dataset related CRUD methods.

Implementation of

JsSDK.datasets

executions

• executions: Executions

The Executions repository. It is used to access Execution related CRUD methods.

Implementation of

JsSDK.executions

drivers

• drivers: Drivers

The Drivers repository. It is used to access Driver related CRUD methods.

Implementation of

JsSDK.drivers

integrations

• integrations: Integrations

The Integrations repository. It is used to access Integration related CRUD methods.

Implementation of

JsSDK.integrations

pipelines

• pipelines: Pipelines

The Pipelines repository. It is used to access Pipeline related CRUD methods.

Implementation of

JsSDK.pipelines

navigator

• navigator: SDKNavigator

The Navigator. It is used to navigate to different routes within the platform.

Implementation of

JsSDK.navigator

Methods

init

▸ init(): Promise<void>

Initializes the xFrame SDK Driver with an agent and all the existing repositories. Initializes agent events.

Returns

Promise<void>

• A promise that resolves once the xFrameDriver instance has been initialized.

Implementation of

JsSDK.init

sendEvent

▸ sendEvent(data): void

Sends an event from the app.

Parameters

Returns

void

Accessors

logger

• get logger(): Logger

Returns the logger object.

Returns

Logger