Interface IModuleMessenger

An interface to communicate with another component.

api-version: 1
user

Hierarchy

IModuleMessenger

Index

Methods

Methods

receive

receive(context: Context, event: string, listener: ((data: Record<string, any>) => void)): void

- Defined in src/api/dart-api.ts:11570
Register an event to be subscribed.

api-version
1

user
Parameters
- context: Context
  
  A caller's context.
- event: string
  
  An event.
- listener: ((data: Record<string, any>) => void)
  
  A listener to receive data of the given event.
  - - (data: Record<string, any>): void
    - Parameters
      - data: Record<string, any>
      Returns void
Returns void

remove

remove(context: Context, event: string, listener: ((data: Record<string, any>) => void)): void

- Defined in src/api/dart-api.ts:11582
Remove a listener matched with the event.

api-version
1

user
Parameters
- context: Context
  
  A caller's context.
- event: string
  
  An event to search.
- listener: ((data: Record<string, any>) => void)
  
  A listener to be removed.
  - - (data: Record<string, any>): void
    - Parameters
      - data: Record<string, any>
      Returns void
Returns void

removeAll

removeAll(context: Context, event?: string): void

- Defined in src/api/dart-api.ts:11594
Remove all listeners matched with the event. If the event is not set, then call listeners which are registered by the context will be removed.

api-version
1

user
Parameters
- context: Context
  
  A caller's context.
- Optional event: string
  
  An event to be removed. If it is not set, then all listeners which are registered by the context will be removed.
Returns void

send

send(context: Context, event: string, data: Record<string, any>): void

- Defined in src/api/dart-api.ts:11558
Send an event to subscriber.

api-version
1

user
Parameters
- context: Context
  
  A caller's context.
- event: string
  
  An event.
- data: Record<string, any>
  
  A data set of key and value pair.
Returns void

Generated using TypeDoc