Class TeachModeService

Service that handles teach mode for generating program nodes.

Hierarchy (View Summary)

MessageInvokerService
- TeachModeService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

getTeachModeState pauseTeachMode postAndAwait postAndObserve request requestObserve resumeTeachMode startTeachMode stopTeachMode

Constructors

constructor

new TeachModeService(eventTarget: EventTargetOrCommChannel): TeachModeService
Creates an instance of TeachModeService.
Parameters
- eventTarget: EventTargetOrCommChannel
Returns TeachModeService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:15

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

getTeachModeState

getTeachModeState(): Observable<TeachModeState>
Retrieves the current state of the teach mode session.

Returns Observable<TeachModeState>
An Observable with the current state of the teach mode session.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:36

pauseTeachMode

pauseTeachMode(): Promise<void>
Pauses the current teach mode session.

Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:27

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

resumeTeachMode

resumeTeachMode(): Promise<void>
Pauses the current teach mode session.

Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:31

startTeachMode

startTeachMode(): Promise<void>
Starts a teach mode session.

Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:19

stopTeachMode

stopTeachMode(): Promise<void>
Stops the current teach mode session.

Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/teach-mode.service.d.ts:23