Interface IModuleChannel

An interface to communicate with another component.

api-version: 1
user

Hierarchy

IModuleChannel

Index

Methods

Methods

containsOnAnotherSide

containsOnAnotherSide(eventNames: string[]): boolean

- Defined in src/api/dart-api.ts:11517
Tells whether the given events are currently registered on another-side channel or not.

api-version
1

user
Parameters
- eventNames: string[]
  
  Event names to search.
Returns boolean
Return true if the given events are registered all on another-side channel, otherwise false.

receive

receive(eventName: string, listener: ((...args: any) => void)): void

- Defined in src/api/dart-api.ts:11506
Register a listener to receive the given event which is sent from another-side channel.

api-version
1

user
Parameters
- eventName: string
  
  An event name.
- listener: ((...args: any) => void)
  
  A listener to receive the given event.
  - - (...args: any): void
    - Parameters
      - Rest ...args: any
      Returns void
Returns void

remove

remove(eventName: string, listener: ((...args: any) => void)): void

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

api-version
1

user
Parameters
- eventName: string
  
  An event name to search.
- listener: ((...args: any) => void)
  
  A listener to remove.
  - - (...args: any): void
    - Parameters
      - Rest ...args: any
      Returns void
Returns void

removeAll

removeAll(eventName: string): void

- Defined in src/api/dart-api.ts:11538
Remove all listeners matched with the event name.

api-version
1

user
Parameters
- eventName: string
  
  An event name to remove.
Returns void

send

send(eventName: string, ...args: any): void

- Defined in src/api/dart-api.ts:11495
Send an event to another-side channel by the string name.

api-version
1

user
Parameters
- eventName: string
  
  An event name.
- Rest ...args: any
  
  Any parameters which are sent.
Returns void

Generated using TypeDoc