Class SmartSkillInstanceService

Service that handles updating smart skill instances

Hierarchy (View Summary)

MessageInvokerService
- SmartSkillInstanceService

Index

Constructors

constructor

new SmartSkillInstanceService(
eventTarget: EventTargetOrCommChannel,
): SmartSkillInstanceService
Parameters
- eventTarget: EventTargetOrCommChannel
Returns SmartSkillInstanceService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-instance.service.d.ts:14

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

getInstance

getInstance(
type: string,
name?: string,
): Promise<SmartSkillInstance | undefined>
Get the smart skill instance by type and optionally name. If name is not provided, the first instance of the type is returned.
Parameters
- type: string
  Type of the smart skill instance
- Optionalname: string
  Optional name of the smart skill instance
Returns Promise<SmartSkillInstance | undefined>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-instance.service.d.ts:30

getInstances

getInstances(): Observable<SmartSkillInstance[]>
Get all smart skill instances as an observable stream.

Returns Observable<SmartSkillInstance[]>
Observable<SmartSkillInstance[]>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-instance.service.d.ts:24

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

updateInstance

updateInstance(instance: SmartSkillInstance): Promise<void>
Update the program node
Parameters
- instance: SmartSkillInstance
  New smart skill instance data
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/smart-skill-instance.service.d.ts:19

Class SmartSkillInstanceService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmartSkillInstanceService

Properties

communicationChannel

`Readonly`eventTarget

Methods

getInstance

Parameters

Returns Promise<SmartSkillInstance | undefined>

getInstances

Returns Observable<SmartSkillInstance[]>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

updateInstance

Parameters

Returns Promise<void>

Settings

On This Page

Class SmartSkillInstanceService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmartSkillInstanceService

Properties

communicationChannel

ReadonlyeventTarget

Methods

getInstance

Parameters

Returns Promise<SmartSkillInstance | undefined>

getInstances

Returns Observable<SmartSkillInstance[]>

postAndAwait

Type Parameters

Parameters

Returns Promise<T>

postAndObserve

Type Parameters

Parameters

Returns Observable<T>

request

Type Parameters

Parameters

Returns Promise<T>

requestObserve

Type Parameters

Parameters

Returns Observable<T>

updateInstance

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`eventTarget