Class LogMessageService

Service for sending log messages

Hierarchy (View Summary)

MessageInvokerService
- LogMessageService

Index

Constructors

Properties

communicationChannel eventTarget

Methods

debug error info postAndAwait postAndObserve request requestObserve sendLogMessage warn

Constructors

constructor

new LogMessageService(eventTarget: EventTargetOrCommChannel): LogMessageService
Create a service for the specific worker
Parameters
- eventTarget: EventTargetOrCommChannel
Returns LogMessageService
Overrides MessageInvokerService.constructor
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:13

Properties

communicationChannel

communicationChannel: CommunicationChannel

`Readonly`eventTarget

eventTarget: EventTargetOrCommChannel

Methods

debug

debug(message: string, type?: string): Promise<void>
Sends a debug log message.
Parameters
- message: string
  The message to be logged
- Optionaltype: string
  The type of message - if not specified 'generic' will be used
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:40

error

error(message: string, type?: string): Promise<void>
Sends a error log message.
Parameters
- message: string
  The message to be logged
- Optionaltype: string
  The type of message - if not specified 'generic' will be used
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:47

info

info(message: string, type?: string): Promise<void>
Sends a info log message.
Parameters
- message: string
  The message to be logged
- Optionaltype: string
  The type of message - if not specified 'generic' will be used
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:33

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

sendLogMessage

sendLogMessage(message: LogMessage): Promise<void>
Sends a log message.
Parameters
- message: LogMessage
  The message to be logged
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:19

warn

warn(message: string, type?: string): Promise<void>
Sends a warning log message.
Parameters
- message: string
  The message to be logged
- Optionaltype: string
  The type of message - if not specified 'generic' will be used
Returns Promise<void>
- Defined in node_modules/@universal-robots/contribution-api/lib/services/logging/log-message.service.d.ts:26