Class: FlyzeApiStoreFacadeInstance

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:39

Abstract class representing a facade for interacting with assets through the Flyze API. This class provides common methods for checking loading, creating, updating, and deleting states and errors.

Extends

• AbstractFacade<"instance">

Constructors

Constructor

new FlyzeApiStoreFacadeInstance(flyzeApi, args): FlyzeApiStoreFacadeInstance

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:69

Parameters

flyzeApi

ApiStoreInstance

args

selectedTagExclusive?

boolean

selectedTagIds?

string[]

Returns

FlyzeApiStoreFacadeInstance

Overrides

AbstractFacade.constructor

Properties

accessControlBindingFacade

readonly accessControlBindingFacade: AccessControlBindingFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:47

---

appointmentEvaluatedOccurrence

readonly appointmentEvaluatedOccurrence: AppointmentEvaluatedOccurrenceFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:51

---

appointmentOccurrence

readonly appointmentOccurrence: AppointmentOccurrenceFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:50

---

appointmentRule

readonly appointmentRule: AppointmentRuleFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:49

---

aspect

readonly aspect: AspectFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:44

---

aspectData

readonly aspectData: AspectDataFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:45

---

aspectDataMigration

readonly aspectDataMigration: AspectDataMigrationFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:46

---

aspectType

readonly aspectType: AspectTypeFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:42

---

aspectTypeMigration

readonly aspectTypeMigration: AspectTypeMigrationFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:43

---

asset

readonly asset: AssetFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:40

---

assetType

readonly assetType: AssetTypeFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:41

---

dataSource

readonly dataSource: DataSourceFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:48

---

dispatch()

readonly dispatch: <V>(action) => void

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:36

Dispatches an action to the store.

Type Parameters

V

V extends Action = Action

Parameters

action

V & FunctionIsNotAllowed<V, "Functions are not allowed to be dispatched. Did you forget to call the action creator function?">

Returns

void

Inherited from

AbstractFacade.dispatch

---

instance

protected instance: ApiStoreInstance

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:51

Inherited from

AbstractFacade.instance

---

resourceReference

readonly resourceReference: ResourceReferenceFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:52

---

section

protected section: "instance"

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:50

Inherited from

AbstractFacade.section

---

select()

readonly select: <T, K>(selector) => Observable<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:34

Selects a slice of state from the store using the provided selector.

Selects a slice of state from the store using the provided selector.

Type Parameters

T

T

K

K

Parameters

selector

MemoizedSelector<T, K>

Returns

Observable<K>

Inherited from

AbstractFacade.select

---

selectedTags$

readonly selectedTags$: Observable<Tag[]>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:62

---

selectSignal()

readonly selectSignal: <K>(selector) => Signal<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:38

Returns a signal of the provided selector.

Returns a signal of the provided selector.

Type Parameters

K

K

Parameters

selector

MemoizedSelector<any, K>

Returns

Signal<K>

Inherited from

AbstractFacade.selectSignal

---

tag

readonly tag: TagFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:53

Accessors

actions

Get Signature

get actions(): object & object[SECTION]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:58

Returns

object & object[SECTION]

Inherited from

AbstractFacade.actions

---

instanceId

Get Signature

get instanceId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:44

Gets the instance ID of the underlying ApiStoreInstance.

Returns

string

Inherited from

AbstractFacade.instanceId

---

selectedTagExclusive

Get Signature

get selectedTagExclusive(): boolean

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:65

Returns

boolean

---

selectedTagIds

Get Signature

get selectedTagIds(): string[]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:58

Returns

string[]

---

selectors

Get Signature

get selectors(): object

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:116

Gets the selectors for the specified section of the API store.

Returns

object

selectAspect()

selectAspect: (q) => DistinctSelector<RootStore, [number | AspectType[], Aspect[]], Aspect[]>

Parameters

q

AssetOrAspectGetQuery<string> & object & _AspectSelectQuery & object

Returns

DistinctSelector<RootStore, [number | AspectType[], Aspect[]], Aspect[]>

selectAspectData()

selectAspectData: (q) => MemoizedSelector<RootStore, AspectData<any>[], (…s) => AspectData<any>[]>

Parameters

q

AspectGetQuery

Returns

MemoizedSelector<RootStore, AspectData<any>[], (…s) => AspectData<any>[]>

selectAspectExpanded()

selectAspectExpanded: (q) => DistinctSelector<RootStore, [Aspect[], AspectData<any>[]], { aspectData: AspectData<any>[]; aspects: Aspect[]; }>

Parameters

q

AssetOrAspectGetQuery<string> & object & _AspectSelectQuery & object

Returns

DistinctSelector<RootStore, [Aspect[], AspectData<any>[]], { aspectData: AspectData<any>[]; aspects: Aspect[]; }>

selectAsset()

selectAsset: (q) => DistinctSelector<RootStore, [number | AssetType[], Asset[]], Asset[]>

Parameters

q

AssetGetQuery

Returns

DistinctSelector<RootStore, [number | AssetType[], Asset[]], Asset[]>

selectAssetExpanded()

selectAssetExpanded: (q) => DistinctSelector<RootStore, [Asset[], Aspect[], AspectData<any>[]], { aspectData: AspectData<any>[]; aspects: Aspect[]; assets: Asset[]; }>

Parameters

q

AssetGetExpandedBody

Returns

DistinctSelector<RootStore, [Asset[], Aspect[], AspectData<any>[]], { aspectData: AspectData<any>[]; aspects: Aspect[]; assets: Asset[]; }>

selectInstanceConfig()

selectInstanceConfig: () => MemoizedSelector<RootStore, { baseUrl: string; id: string; }, (s1) => object>

Returns

MemoizedSelector<RootStore, { baseUrl: string; id: string; }, (s1) => object>

selectResourceReference()

selectResourceReference: {(q): MemoizedSelector<RootStore, Asset | undefined>; (q): MemoizedSelector<RootStore, AssetType | undefined>; (q): MemoizedSelector<RootStore, Aspect | undefined>; (q): MemoizedSelector<RootStore, AspectType | undefined>; (q): MemoizedSelector<RootStore, AspectData<any> | undefined>; (q): MemoizedSelector<RootStore, null>; (q): MemoizedSelector<RootStore, null>; }

Call Signature

(q): MemoizedSelector<RootStore, Asset | undefined>

Parameters

q

ResourceGetEntityKindReferenceQuery<"asset">

Returns

MemoizedSelector<RootStore, Asset | undefined>

Call Signature

(q): MemoizedSelector<RootStore, AssetType | undefined>

Parameters

q

ResourceGetEntityKindReferenceQuery<"asset-type">

Returns

MemoizedSelector<RootStore, AssetType | undefined>

Call Signature

(q): MemoizedSelector<RootStore, Aspect | undefined>

Parameters

q

ResourceGetEntityKindReferenceQuery<"aspect">

Returns

MemoizedSelector<RootStore, Aspect | undefined>

Call Signature

(q): MemoizedSelector<RootStore, AspectType | undefined>

Parameters

q

ResourceGetEntityKindReferenceQuery<"aspect-type">

Returns

MemoizedSelector<RootStore, AspectType | undefined>

Call Signature

(q): MemoizedSelector<RootStore, AspectData<any> | undefined>

Parameters

q

ResourceGetEntityKindReferenceQuery<"aspect-data">

Returns

MemoizedSelector<RootStore, AspectData<any> | undefined>

Call Signature

(q): MemoizedSelector<RootStore, null>

Parameters

q

ResourceGetEntityKindReferenceQuery<"appointment-rule">

Returns

MemoizedSelector<RootStore, null>

Call Signature

(q): MemoizedSelector<RootStore, null>

Parameters

q

ResourceGetEntityKindReferenceQuery<"appointment-occurrence">

Returns

MemoizedSelector<RootStore, null>

Overrides

AbstractFacade.selectors

Methods

_dispatchWithId()

protected _dispatchWithId<PROPS>(action, props): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:92

Dispatches an action with a newly generated actionId.

Type Parameters

PROPS

PROPS extends object & object

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

Returns

string

The generated actionId.

Inherited from

AbstractFacade._dispatchWithId

---

_dispatchWithResult$()

protected _dispatchWithResult$<PROPS, TYPE, DATA>(action, props, finishSelector): Observable<FacadeFinished<DATA>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:108

Extends the _dispatchWithId method to return an observable that emits when the action is finished.

Type Parameters

PROPS

PROPS extends object & object

TYPE

TYPE

DATA

DATA

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

finishSelector

(actionId) => MemoizedSelector<any, FinishedSelectorResponse<DATA>>

A selector function that takes an actionId and returns a FinishSelector for the action.

Returns

Observable<FacadeFinished<DATA>>

An observable that emits when the action is finished.

Inherited from

AbstractFacade._dispatchWithResult$

---

getFinishedObservable()

protected getFinishedObservable<T, D>(selector): Observable<FacadeFinished<D>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:77

Type Parameters

T

T

D

D

Parameters

selector

MemoizedSelector<any, FinishedSelectorResponse<D>>

Returns

Observable<FacadeFinished<D>>

Inherited from

AbstractFacade.getFinishedObservable

---

getNewId()

protected getNewId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:73

utility method to generate a new GUID. This is used to track actions.

Returns

string

A new GUID.

Inherited from

AbstractFacade.getNewId

---

loadAssetExpandData()

loadAssetExpandData(query): Observable<{ data?: undefined; error: string; finished: true; } | { data: { aspectDatas: AspectData<any>[] | undefined; aspects: Aspect[] | undefined; assets: Asset[] | undefined; }; error?: undefined; finished: true; }>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/flyze-api-store-instance.facade.ts:158

Load expanded asset data including aspects and aspect data.

Parameters

query

Omit<AssetGetExpandedBody, "includeData">

Returns

Observable<{ data?: undefined; error: string; finished: true; } | { data: { aspectDatas: AspectData<any>[] | undefined; aspects: Aspect[] | undefined; assets: Asset[] | undefined; }; error?: undefined; finished: true; }>