Class: StatefulBasicLifecycle

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

A variant of BasicLifecycle that keeps track of its own pause/resume state and immediately pauses or resumes subscriptions when they are registered depending on whether it (the lifecycle) is paused or resumed at the time.

Extends

• BasicLifecycle

Constructors

Constructor

new StatefulBasicLifecycle(notifyOnResume, isResumed): StatefulBasicLifecycle

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

Creates an instance of a StatefulLifecycle.

Parameters

Parameter	Type	Default value	Description
notifyOnResume	boolean	undefined	Whether to immediately trigger notifications to this lifecycle's registered subscriptions when this lifecycle is resumed.
isResumed	boolean	false	Whether the lifecycle is initially resumed. Defaults to false.

Returns

StatefulBasicLifecycle

Overrides

BasicLifecycle.constructor

Properties

_isResumed

protected _isResumed: boolean

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

---

isDestroyed

protected isDestroyed: boolean = false

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

Inherited from

BasicLifecycle.isDestroyed

---

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.

Inherited from

BasicLifecycle.notifyOnResume

---

subscriptions?

protected optional subscriptions: Subscription[]

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

Inherited from

BasicLifecycle.subscriptions

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

Inherited from

BasicLifecycle.destroy

---

isResumed()

isResumed(): boolean

Defined in: src/sdk/sub/StatefulBasicLifecycle.ts:27

Checks whether this lifecycle is resumed.

Returns

boolean

Whether this lifecycle is resumed.

---

pause()

pause(): void

Defined in: src/sdk/sub/StatefulBasicLifecycle.ts:45

Pauses subscriptions in this lifecycle.

Returns

void

Overrides

BasicLifecycle.pause

---

register()

register(sub): void

Defined in: src/sdk/sub/StatefulBasicLifecycle.ts:32

Registers a subscription to the lifecycle.

Parameters

Parameter	Type	Description
sub	Subscription	The subscription to register.

Returns

void

Overrides

BasicLifecycle.register

---

resume()

resume(): void

Defined in: src/sdk/sub/StatefulBasicLifecycle.ts:56

Resumes subscriptions in this lifecycle.

Returns

void

Overrides

BasicLifecycle.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

Inherited from

BasicLifecycle.unregister