Class default

ExternalControllerUpdaterAPI provides access to the CrossModelRelations API facade.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

externalControllerInfo setExternalControllerInfo watchExternalControllers

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/external-controller-updater/ExternalControllerUpdaterV1.ts:89

Properties

NAME

NAME: string = "ExternalControllerUpdater"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "ExternalControllerUpdater"

`Static` VERSION

VERSION: number = 1

Methods

externalControllerInfo

externalControllerInfo(params: Entities): Promise<ExternalControllerInfoResults>
ExternalControllerInfo returns the info for the specified external controllers.
Parameters
- params: Entities
Returns Promise<ExternalControllerInfoResults>
- Defined in api/facades/external-controller-updater/ExternalControllerUpdaterV1.ts:99

setExternalControllerInfo

setExternalControllerInfo(params: SetExternalControllersInfoParams): Promise<ErrorResults>
SetExternalControllerInfo saves the info for the specified external controllers.
Parameters
- params: SetExternalControllersInfoParams
Returns Promise<ErrorResults>
- Defined in api/facades/external-controller-updater/ExternalControllerUpdaterV1.ts:117

watchExternalControllers

watchExternalControllers(params: any): Promise<StringsWatchResults>
WatchExternalControllers watches for the addition and removal of external controller records to the local controller's database.
Parameters
- params: any
Returns Promise<StringsWatchResults>
- Defined in api/facades/external-controller-updater/ExternalControllerUpdaterV1.ts:136

Generated using TypeDoc