Class ProgramService

Service for handling program related operations

Hierarchy (View Summary)

MessageInvokerService
- ProgramService

Index

Constructors

constructor

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

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

getLoadedProgram

getLoadedProgram(): Promise<ProgramInformation>
Retrieves the loaded program's information.

This method sends a request to the backend to retrieve the information of the currently loaded program.

Returns Promise<ProgramInformation>
A promise that resolves to the information of the loaded program.
Example
```
// Usage example
const programInfo = await this.presenterAPI.programService.getLoadedProgram()
console.log('Loaded Program Information:', programInfo);
```
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program.service.d.ts:46

getProgram

getProgram(programInformation: ProgramInformation): Promise<Program>
Get a program
Parameters
- programInformation: ProgramInformation
Returns Promise<Program>
Promise
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program.service.d.ts:24

getProgramsList

getProgramsList(): Promise<ProgramInformation[]>
Will get information and metadata of all programs

Returns Promise<ProgramInformation[]>
Promise<Array>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program.service.d.ts:18

loadProgram

loadProgram(programId: { programId: string }): Promise<void>
Load program
Parameters
- programId: { programId: string }
  The id of the program to load
Returns Promise<void>
See
getPrograms for getting the ids
- Defined in node_modules/@universal-robots/contribution-api/lib/services/program/program.service.d.ts:30

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

Class ProgramService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProgramService

Properties

communicationChannel

ReadonlyeventTarget

Methods

getLoadedProgram

Returns Promise<ProgramInformation>

Example

getProgram

Parameters

Returns Promise<Program>

getProgramsList

Returns Promise<ProgramInformation[]>

loadProgram

Parameters

Returns Promise<void>

See

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>

Settings

On This Page

`Readonly`eventTarget