INativeEventBus.md

@js-soft/native-abstractions / Exports / INativeEventBus

Interface: INativeEventBus

Event bus used for sending and receiving messages

Table of contents

Methods

• init
• publish
• subscribe
• subscribeOnce
• unsubscribe

Methods

init

▸ init(): Promise<Result<void, ApplicationError>>

Initialize the event bus. Initially the event bus is in a locked state. Once an AppReadyEvent is fired (usually from outside), the event bus is unlocked. The locked event bus queues published events and publishes them once it is unlocked.

Returns

Promise<Result<void, ApplicationError>>

Defined in

src/INativeEventBus.ts:34

---

publish

▸ publish(event): Result<void, ApplicationError>

Publish a specific event

Parameters

Name	Type
event	Event

Returns

Result<void, ApplicationError>

Defined in

src/INativeEventBus.ts:28

---

subscribe

▸ subscribe(event, handler): Result<number, ApplicationError>

Subscribe for a handler to be called each time a specific event occurs

Parameters

Name	Type
event	Event
handler	Function

Returns

Result<number, ApplicationError>

Defined in

src/INativeEventBus.ts:12

---

subscribeOnce

▸ subscribeOnce(event, handler): Result<number, ApplicationError>

Subscribe for a handler to be called the next time a specific event occurs

Parameters

Name	Type
event	Event
handler	Function

Returns

Result<number, ApplicationError>

Defined in

src/INativeEventBus.ts:18

---

unsubscribe

▸ unsubscribe(id): Result<void, ApplicationError>

Unsunscribe a handler from being called when a specific event occurs

Parameters

Name	Type
id	number

Returns

Result<void, ApplicationError>

Defined in

src/INativeEventBus.ts:23