Class Connection

Hierarchy

Base
- Connection

Index

Constructors

Properties

Methods

getAllConnections createConnectionInstances createNewConnection getConnection triggerSync

Constructors

constructor

new Connection(workspace: WorkspaceModel): Connection
Parameters
- workspace: WorkspaceModel
Returns Connection

Overrides Base.constructor

Properties

forWorkspace

forWorkspace: WorkspaceModel

Methods

getAllConnections

getAllConnections(includeDeleted?: boolean): Promise<ConnectionModel[]>
Parameters
- includeDeleted: boolean = false
Returns Promise<ConnectionModel[]>

`Static` createConnectionInstances

createConnectionInstances(connections: ConnectionRead[]): ConnectionModel[]
Parameters
- connections: ConnectionRead[]
Returns ConnectionModel[]

`Static` createNewConnection

createNewConnection(connectionCreate: ConnectionCreate): Promise<ConnectionModel>
Parameters
- connectionCreate: ConnectionCreate
Returns Promise<ConnectionModel>

`Static` getConnection

getConnection(connectionId: string): Promise<ConnectionModel>
Parameters
- connectionId: string
Returns Promise<ConnectionModel>

`Static` triggerSync

triggerSync(connectionId: string): Promise<JobInfoRead>
Parameters
- connectionId: string
Returns Promise<JobInfoRead>

Generated using TypeDoc