Class ProgramTreeService

Service that handles node insertion and removal of nodes

Hierarchy (view full)

MessageInvokerService
- ProgramTreeService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

addNode getContributedNodeInstancesForURCap getProgramNodeById getTreeContextFromProgramNodeById postAndAwait postAndObserve removeChildNode request requestObserve selectProgramNode setActiveProgramBlock updateChildNode updateSubTreeNode

Constructors

constructor

new ProgramTreeService(eventTarget): ProgramTreeService
Parameters
- eventTarget: UREventTarget
Returns ProgramTreeService
Overrides MessageInvokerService.constructor
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: UREventTarget

Methods

addNode

addNode(node): Promise<void>
Add node as either child or sibling
Parameters
- node: AddNode
  node to be added
Returns Promise<void>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:30

getContributedNodeInstancesForURCap

getContributedNodeInstancesForURCap(): Promise<SubtreeNode[]>
Get the contributed node instances for the URCap that are currently inserted in the program

Returns Promise<SubtreeNode[]>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:58

getProgramNodeById

getProgramNodeById(nodeID): Promise<Readonly<ProgramNode>>
Get a readonly version of a given node
Parameters
- nodeID: string
  The node to get
Returns Promise<Readonly<ProgramNode>>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:50

getTreeContextFromProgramNodeById

getTreeContextFromProgramNodeById(subTreeNodeId): Promise<TreeContext>
Get the tree context from a given program node
Parameters
- subTreeNodeId: string
Returns Promise<TreeContext>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:54

postAndAwait

postAndAwait<T>(type, data?): 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 @universal-robots/contribution-api/lib/services/message-invoker.d.ts:178

postAndObserve

postAndObserve<T>(type, data?): 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 @universal-robots/contribution-api/lib/services/message-invoker.d.ts:185

removeChildNode

removeChildNode(node): Promise<void>
Remove child node
Parameters
- node: RemoveNode
  Child node to be removed
Returns Promise<void>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:35

request

request<T>(type, data?): 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 @universal-robots/contribution-api/lib/services/message-invoker.d.ts:164

requestObserve

requestObserve<T>(type, data?): 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 @universal-robots/contribution-api/lib/services/message-invoker.d.ts:171

selectProgramNode

selectProgramNode(nodeID): Promise<void>
Sets the given node as the active program block
Parameters
- nodeID: string
  The node to navigate to
Returns Promise<void>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:45

setActiveProgramBlock

setActiveProgramBlock(nodeID): Promise<void>
Sets the given node as the active program block
Parameters
- nodeID: string
  The node to navigate to
Returns Promise<void>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:40

updateChildNode

updateChildNode(node): Promise<void>
Update child node
Parameters
- node: SubtreeNode
  Child node to be updated
Returns Promise<void>
Deprecated
Use updateSubTreeNode instead
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:25

updateSubTreeNode

updateSubTreeNode(node): Promise<void>
Update a specific node in the program tree using the given nodes id
Parameters
- node: SubtreeNode
  Node to be updated
Returns Promise<void>
- Defined in @universal-robots/contribution-api/lib/services/program/program-tree.service.d.ts:19