Class ApplicationVariablesService

Service for managing application variables.

Hierarchy (View Summary)

MessageInvokerService
- ApplicationVariablesService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

applicationVariables cleanUpControllerVariables createVariable deleteVariable initializeVariables postAndAwait postAndObserve request requestObserve setVariable

Constructors

constructor

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

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

applicationVariables

applicationVariables(): Observable<Record<string, ApplicationVariable>>
Retrieves all application variables as an observable.

Returns Observable<Record<string, ApplicationVariable>>
An observable that emits a record of application variables.
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.service.d.ts:19

cleanUpControllerVariables

cleanUpControllerVariables(): Promise<void>
Sends request to clean up variables in controller.

Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.service.d.ts:29

createVariable

createVariable(variable: ApplicationVariable): Promise<void>
Sends request to create a new variable.
Parameters
- variable: ApplicationVariable
  The ApplicationVariable object to create.
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.service.d.ts:39

deleteVariable

deleteVariable(variableName: string): Promise<void>
Sends request to delete an existing variable.
Parameters
- variableName: string
  The name of the variable to delete.
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.service.d.ts:44

initializeVariables

initializeVariables(
variables: Record<string, ApplicationVariable>,
): Promise<void>
Sends request to initialize variables in controller and store.
Parameters
- variables: Record<string, ApplicationVariable>
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.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

setVariable

setVariable(variable: ApplicationVariable): Promise<void>
Sends request to set value of an existing variable.
Parameters
- variable: ApplicationVariable
  The ApplicationVariable object to create.
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/application-variables/application-variables.service.d.ts:34