Class SnackbarService

Service that handles showing snack notifications.

Hierarchy (View Summary)

MessageInvokerService
- SnackbarService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

postAndAwait postAndObserve request requestObserve showSnackbar

Constructors

constructor

new SnackbarService(eventTarget: EventTargetOrCommChannel): SnackbarService
Create a service for the specific eventTarget
Parameters
- eventTarget: EventTargetOrCommChannel
Returns SnackbarService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/ui/snackbar.service.d.ts:12

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

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

showSnackbar

showSnackbar(message: string, type?: string, title?: string): Promise<any>
Open a snack notification.
Parameters
- message: string
  Snackbar message
- Optionaltype: string
  Optional. Type of notification (success, error, warning, info(default)).
- Optionaltitle: string
  Optional. Snackbar title
Returns Promise<any>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/ui/snackbar.service.d.ts:19