Class: BasicLifecycle

Defined in: src/sdk/sub/BasicLifecycle.ts:8

A subscription lifecycle that pauses all registered subscriptions when the lifecycle is paused and resumes all registered subscriptions when the lifecycle is resumed.

Extended by

• StatefulBasicLifecycle

Implements

• Lifecycle

Constructors

Constructor

new BasicLifecycle(notifyOnResume): BasicLifecycle

Defined in: src/sdk/sub/BasicLifecycle.ts:17

Creates an instance of a BasicLifecycle.

Parameters

Parameter	Type	Description
notifyOnResume	boolean	Whether to immediately trigger notifications to this lifecycle's registered subscriptions when this lifecycle is resumed.

Returns

BasicLifecycle

Properties

isDestroyed

protected isDestroyed: boolean = false

Defined in: src/sdk/sub/BasicLifecycle.ts:10

---

notifyOnResume

readonly notifyOnResume: boolean

Defined in: src/sdk/sub/BasicLifecycle.ts:17

Whether to immediately trigger notifications to this lifecycle's registered subscriptions when this lifecycle is resumed.

---

subscriptions?

protected optional subscriptions: Subscription[]

Defined in: src/sdk/sub/BasicLifecycle.ts:9

Methods

destroy()

destroy(): void

Defined in: src/sdk/sub/BasicLifecycle.ts:61

Destroys subscriptions in this lifecycle. All registered subscriptions will be unregistered.

Returns

void

Implementation of

Lifecycle.destroy

---

pause()

pause(): void

Defined in: src/sdk/sub/BasicLifecycle.ts:43

Pauses subscriptions in this lifecycle.

Returns

void

Implementation of

Lifecycle.pause

---

register()

register(sub): void

Defined in: src/sdk/sub/BasicLifecycle.ts:20

Registers a subscription to the lifecycle.

Parameters

Parameter	Type	Description
sub	Subscription	The subscription to register.

Returns

void

Implementation of

Lifecycle.register

---

resume()

resume(): void

Defined in: src/sdk/sub/BasicLifecycle.ts:52

Resumes subscriptions in this lifecycle.

Returns

void

Implementation of

Lifecycle.resume

---

unregister()

unregister(sub): void

Defined in: src/sdk/sub/BasicLifecycle.ts:33

Unregisters a subscription from the lifecycle.

Parameters

Parameter	Type	Description
sub	Subscription	The subscription to unregister.

Returns

void

Implementation of

Lifecycle.unregister