Class Destination

Hierarchy

Base
- Destination

Index

Constructors

Properties

Methods

getAllDestinations getDestination searchDestinationByName searchDestinations updateDestination clone createDestinationInstances createNewDestination deleteDestination

Constructors

constructor

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

Overrides Base.constructor

Properties

forWorkspace

forWorkspace: WorkspaceModel

Methods

getAllDestinations

getAllDestinations(): Promise<DestinationModel[]>
Returns Promise<DestinationModel[]>

getDestination

getDestination(destinationId: string): Promise<DestinationModel>
Parameters
- destinationId: string
Returns Promise<DestinationModel>

searchDestinationByName

searchDestinationByName(name: string): Promise<DestinationModel[]>
Parameters
- name: string
Returns Promise<DestinationModel[]>

searchDestinations

searchDestinations(searchParams: DestinationSearch): Promise<DestinationModel[]>
Parameters
- searchParams: DestinationSearch
Returns Promise<DestinationModel[]>

updateDestination

updateDestination(destinationId: string, updateObject: Partial<DestinationRead>): Promise<DestinationModel>
Parameters
- destinationId: string
- updateObject: Partial<DestinationRead>
Returns Promise<DestinationModel>

`Static` clone

clone(destinationId: string, updateConfig: DestinationCloneConfiguration, checkIfConfigIsValid?: boolean): Promise<DestinationModel>
Parameters
- destinationId: string
- updateConfig: DestinationCloneConfiguration
- checkIfConfigIsValid: boolean = true
Returns Promise<DestinationModel>

`Static` createDestinationInstances

createDestinationInstances(destinations: DestinationRead[]): DestinationModel[]
Parameters
- destinations: DestinationRead[]
Returns DestinationModel[]

`Static` createNewDestination

createNewDestination(createDestinationData: DestinationCreate, checkIfConfigIsValid?: boolean): Promise<DestinationModel>
Parameters
- createDestinationData: DestinationCreate
- checkIfConfigIsValid: boolean = true
Returns Promise<DestinationModel>

`Static` deleteDestination

deleteDestination(destinationId: string): Promise<void>
Parameters
- destinationId: string
Returns Promise<void>

Generated using TypeDoc