Implementation of a redux feature to manage authoring layouts.

API Documentation

Home > @acoustic-content-sdk/redux-feature-auth-layout

redux-feature-auth-layout package

Implementation of a redux feature to manage authoring layouts.

Interfaces

| Interface | Description | | --- | --- | | AuthLayoutFeatureState | |

Variables

| Variable | Description | | --- | --- | | ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT | | | ACTION_ADD_AUTH_LAYOUT | | | ACTION_GUARANTEE_AUTH_LAYOUT | | | ACTION_LOAD_AUTH_LAYOUT | | | ACTION_SET_AUTH_LAYOUT | Do not add a side effect to this action | | addAuthoringLayoutAction | | | addAuthoringLayoutIfNonExistentAction | Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addAuthoringLayoutAction. | | AUTH_LAYOUT_FEATURE | | | authLayoutFeatureReducer | | | authoringLayoutFeature | Exposes the feature module selector | | authoringLayoutReducer | reducers for authoring content | | guaranteeAuthoringLayoutAction | | | loadAuthoringLayoutAction | | | selectAuthLayoutFeature | Select the authoring type feature | | selectAuthoringLayout | | | setAuthoringLayoutAction | | | VERSION | Version and build number of the package |

Type Aliases

| Type Alias | Description | | --- | --- | | AddAuthoringLayoutAction | | | AddAuthoringLayoutIfNonExistentAction | | | AuthoringLayoutState | | | GuaranteeAuthoringLayoutAction | | | LoadAuthoringLayoutAction | | | SetAuthoringLayoutAction | |

Home > @acoustic-content-sdk/redux-feature-auth-layout > AuthLayoutFeatureState

AuthLayoutFeatureState interface

Signature:

export interface AuthLayoutFeatureState 

Properties

| Property | Type | Description | | --- | --- | --- | | authLayout | AuthoringLayoutState | |

Home > @acoustic-content-sdk/redux-feature-auth-layout > ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT

ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT variable

Signature:

ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT = "ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT"

Home > @acoustic-content-sdk/redux-feature-auth-layout > ACTION_ADD_AUTH_LAYOUT

ACTION_ADD_AUTH_LAYOUT variable

Signature:

ACTION_ADD_AUTH_LAYOUT = "ACTION_ADD_AUTH_LAYOUT"

Home > @acoustic-content-sdk/redux-feature-auth-layout > ACTION_GUARANTEE_AUTH_LAYOUT

ACTION_GUARANTEE_AUTH_LAYOUT variable

Signature:

ACTION_GUARANTEE_AUTH_LAYOUT = "ACTION_GUARANTEE_AUTH_LAYOUT"

Home > @acoustic-content-sdk/redux-feature-auth-layout > ACTION_LOAD_AUTH_LAYOUT

ACTION_LOAD_AUTH_LAYOUT variable

Signature:

ACTION_LOAD_AUTH_LAYOUT = "ACTION_LOAD_AUTH_LAYOUT"

Home > @acoustic-content-sdk/redux-feature-auth-layout > ACTION_SET_AUTH_LAYOUT

ACTION_SET_AUTH_LAYOUT variable

Do not add a side effect to this action

Signature:

ACTION_SET_AUTH_LAYOUT = "ACTION_SET_AUTH_LAYOUT"

Home > @acoustic-content-sdk/redux-feature-auth-layout > addAuthoringLayoutAction

addAuthoringLayoutAction variable

Signature:

addAuthoringLayoutAction: UnaryFunction<AuthoringLayoutItem, AddAuthoringLayoutAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > addAuthoringLayoutIfNonExistentAction

addAuthoringLayoutIfNonExistentAction variable

Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addAuthoringLayoutAction.

Signature:

addAuthoringLayoutIfNonExistentAction: UnaryFunction<AuthoringLayoutItem, AddAuthoringLayoutIfNonExistentAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > AUTH_LAYOUT_FEATURE

AUTH_LAYOUT_FEATURE variable

Signature:

AUTH_LAYOUT_FEATURE = "authLayout"

Home > @acoustic-content-sdk/redux-feature-auth-layout > authLayoutFeatureReducer

authLayoutFeatureReducer variable

Signature:

authLayoutFeatureReducer: {
    authLayout: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>, import("./auth.layout.actions").AddAuthoringLayoutAction | import("./auth.layout.actions").SetAuthoringLayoutAction>;
}

Home > @acoustic-content-sdk/redux-feature-auth-layout > authoringLayoutFeature

authoringLayoutFeature variable

Exposes the feature module selector

Signature:

authoringLayoutFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>, AuthLayoutFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

Home > @acoustic-content-sdk/redux-feature-auth-layout > authoringLayoutReducer

authoringLayoutReducer variable

reducers for authoring content

Signature:

authoringLayoutReducer: Reducer<AuthoringLayoutState, AddAuthoringLayoutAction | SetAuthoringLayoutAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > guaranteeAuthoringLayoutAction

guaranteeAuthoringLayoutAction variable

Signature:

guaranteeAuthoringLayoutAction: UnaryFunction<string, GuaranteeAuthoringLayoutAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > loadAuthoringLayoutAction

loadAuthoringLayoutAction variable

Signature:

loadAuthoringLayoutAction: UnaryFunction<string, LoadAuthoringLayoutAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > selectAuthLayoutFeature

selectAuthLayoutFeature variable

Select the authoring type feature

Signature:

selectAuthLayoutFeature: import("rxjs").UnaryFunction<Record<string, any>, Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>>

Home > @acoustic-content-sdk/redux-feature-auth-layout > selectAuthoringLayout

selectAuthoringLayout variable

Signature:

selectAuthoringLayout: UnaryFunction<string, UnaryFunction<AuthoringLayoutState, AuthoringLayoutItem>>

Home > @acoustic-content-sdk/redux-feature-auth-layout > setAuthoringLayoutAction

setAuthoringLayoutAction variable

Signature:

setAuthoringLayoutAction: UnaryFunction<AuthoringLayoutItem, SetAuthoringLayoutAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/redux-feature-auth-layout > AuthoringLayoutState

AuthoringLayoutState type

Signature:

export declare type AuthoringLayoutState = Record<string, AuthoringLayoutItem>;

Home > @acoustic-content-sdk/redux-feature-auth-layout > AuthLayoutFeatureState > authLayout

AuthLayoutFeatureState.authLayout property

Signature:

[AUTH_LAYOUT_FEATURE]: AuthoringLayoutState;