Class SettingsService

A service for getting settings such as language and units

Hierarchy (View Summary)

MessageInvokerService
- SettingsService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

getRobotSettings getRobotSettingsOnce postAndAwait postAndObserve request requestObserve

Constructors

constructor

new SettingsService(eventTarget: EventTargetOrCommChannel): SettingsService
Parameters
- eventTarget: EventTargetOrCommChannel
Returns SettingsService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/settings/settings.service.d.ts:13

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

getRobotSettings

getRobotSettings(): Observable<RobotSettings>
Get the current robot settings as an observable

Returns Observable<RobotSettings>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/settings/settings.service.d.ts:17

getRobotSettingsOnce

getRobotSettingsOnce(): Promise<RobotSettings>
Get the current robot settings once

Returns Promise<RobotSettings>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/settings/settings.service.d.ts:21

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