Class: xFrameDriver

main.xFrameDriver

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

Hierarchy

  • EventEmitter

    ↳ xFrameDriver

Implements

  • JsSDK

Table of contents

Properties

Methods

Properties

agent

• agent: PeerAgent

The application's agent.

annotations

• annotations: Annotations

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

attributes

• attributes: Attributes

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

contributors

• contributors: Contributors

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

datasets

• datasets: Datasets

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

drivers

• drivers: Drivers

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

executions

• executions: Executions

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

items

• items: Items

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

labels

• labels: Labels

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

ontologies

• ontologies: Ontologies

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

projects

• projects: Projects

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

recipes

• recipes: Recipes

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

settings

• settings: AppSettings

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

structures

• structures: Structures

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

tasks

• tasks: Tasks

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

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.