Class RobotInfoService

Provides access to information on the robot

Hierarchy

MessageInvokerService
- RobotInfoService

Index

Constructors

Properties

Methods

getRobotType postAndAwait postAndObserve

Constructors

constructor

new RobotInfoService(eventTarget: EventTarget): RobotInfoService
Parameters
- eventTarget: EventTarget
Returns RobotInfoService
Overrides MessageInvokerService.constructor
- Defined in contribution-api/lib/services/robot/robot-info.service.d.ts:12

Properties

`Readonly` eventTarget

eventTarget: EventTarget

Methods

getRobotType

getRobotType(): Promise<string>
Get the robot type

Returns Promise<string>
- Defined in contribution-api/lib/services/robot/robot-info.service.d.ts:16

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
- Optional data: any
  
  The message data
Returns Promise<T>
Inherited from MessageInvokerService.postAndAwait
- Defined in contribution-api/lib/services/message-invoker.d.ts:44

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
- Optional data: any
  
  The message data
Returns Observable<T>
Inherited from MessageInvokerService.postAndObserve
- Defined in contribution-api/lib/services/message-invoker.d.ts:51

Generated using TypeDoc