Class TreeBuilder

TreeBuilder Provides methods to build program node trees that can then be passed to the application for insertion to the main program.

Hierarchy (View Summary)

MessageInvokerService
- TreeBuilder

Index

Constructors

Properties

communicationChannel eventTarget

Methods

appendChild createBranchNode createNode postAndAwait postAndObserve request requestObserve

Constructors

constructor

new TreeBuilder(eventTarget: EventTargetOrCommChannel): TreeBuilder
Parameters
- eventTarget: EventTargetOrCommChannel
Returns TreeBuilder
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/tree-builder.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

appendChild

appendChild(parentNode: BranchNode, node: ProgramNode): void
Appends a child node to the subtree of the given parent node
Parameters
- parentNode: BranchNode
  The BranchNode to add the child to
- node: ProgramNode
  The child ProgramNode to be added to the subtree
Returns void
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/tree-builder.d.ts:26

createBranchNode

createBranchNode(node: ProgramNode): BranchNode
Turns the passed in ProgramNode into a BranchNode, allowing children to be added to the subtree of the given node.
Parameters
- node: ProgramNode
  The ProgramNode to convert to a BranchNode
Returns BranchNode
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/tree-builder.d.ts:20

createNode

createNode(ofType: string): Promise<ProgramNode>
Requests a new instance of a ProgramNode from the application
Parameters
- ofType: string
  The type of the ProgramNode to be instantiated - see the nodeType enum for the builtin types.
Returns Promise<ProgramNode>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/tree-builder.d.ts:32

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