Class default

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

modelEnvironVersion modelTargetEnvironVersion setModelEnvironVersion setModelStatus watchModelEnvironVersion

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:93

Properties

NAME

NAME: string = "EnvironUpgrader"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "EnvironUpgrader"

`Static` VERSION

VERSION: number = 1

Methods

modelEnvironVersion

modelEnvironVersion(params: Entities): Promise<IntResults>
ModelEnvironVersion returns the current version of the environ corresponding to each specified model.
Parameters
- params: Entities
Returns Promise<IntResults>
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:104

modelTargetEnvironVersion

modelTargetEnvironVersion(params: Entities): Promise<IntResults>
ModelTargetEnvironVersion returns the target version of the environ corresponding to each specified model. The target version is the environ provider's version.
Parameters
- params: Entities
Returns Promise<IntResults>
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:122

setModelEnvironVersion

setModelEnvironVersion(params: SetModelEnvironVersions): Promise<ErrorResults>
SetModelEnvironVersion sets the current version of the environ corresponding to each specified model.
Parameters
- params: SetModelEnvironVersions
Returns Promise<ErrorResults>
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:139

setModelStatus

setModelStatus(params: SetStatus): Promise<ErrorResults>
SetModelStatus sets the status of each given model.
Parameters
- params: SetStatus
Returns Promise<ErrorResults>
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:157

watchModelEnvironVersion

watchModelEnvironVersion(params: Entities): Promise<NotifyWatchResults>
WatchModelEnvironVersion watches for changes to the environ version of the specified models.

NOTE(axw) this is currently implemented in terms of state.Model.Watch, so the client may be notified of changes unrelated to the environ version.
Parameters
- params: Entities
Returns Promise<NotifyWatchResults>
- Defined in api/facades/environ-upgrader/EnvironUpgraderV1.ts:177

Generated using TypeDoc