Class ValidationService

Allows program nodes to obtain the validation response generated from their respective behavior worker.

Hierarchy (View Summary)

MessageInvokerService
- ValidationService

Index

Constructors

constructor

new ValidationService(
eventTarget: UREventTarget | CommunicationChannel,
selectedNodeId: string,
): ValidationService
Creates a new instance of the ValidationService
Parameters
- eventTarget: UREventTarget | CommunicationChannel
  the target to send message events on
- selectedNodeId: string
  the id of the currently selected node
Returns ValidationService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/validation.service.d.ts:15

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: UREventTarget | CommunicationChannel

Methods

getValidationResponse

getValidationResponse(nodeId?: string): Promise<ValidationResponse>
Returns the last validation response generated from the behavior worker. If the node is valid the returned response will be exactly { isValid: true } without any extra data.
Parameters
- OptionalnodeId: string
Returns Promise<ValidationResponse>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/validation.service.d.ts:20

postAndAwait

postAndAwait<T>(type: string, data?: any): Promise<T>
returns a reply promise to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:192

postAndObserve

postAndObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the specified message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:199

request

request<T>(type: string, data?: any): Promise<T>
returns a reply promise for the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.request
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

requestObserve

requestObserve<T>(type: string, data?: any): Observable<T>
returns an observable that will emit any messages replied to the requested message
Type Parameters
- T
Parameters
- type: string
  The type of message being sent
- Optionaldata: any
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.requestObserve
- Defined in node_modules/@universal-robots/contribution-api/lib/services/message-invoker.d.ts:185

Class ValidationService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValidationService

Properties

communicationChannel

`Readonly`eventTarget

Methods

getValidationResponse

Parameters

Returns Promise<ValidationResponse>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

Settings

On This Page

Class ValidationService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ValidationService

Properties

communicationChannel

ReadonlyeventTarget

Methods

getValidationResponse

Parameters

Returns Promise<ValidationResponse>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

Settings

On This Page

`Readonly`eventTarget