@acoustic-content-sdk/redux-feature-auth-layout-mapping

Implementation of a redux feature to manage authoring layout mappings.

API Documentation

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

redux-feature-auth-layout-mapping package

Implementation of a redux feature to manage authoring layout mappings.

Interfaces

Interface	Description
AuthLayoutMappingFeatureState

Variables

Variable	Description
ACTION_ADD_AUTH_LAYOUT_MAPPING_IF_NONEXISTENT
ACTION_ADD_AUTH_LAYOUT_MAPPING
ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING_BY_TYPE
ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING
ACTION_LOAD_AUTH_LAYOUT_MAPPING
ACTION_SET_AUTH_LAYOUT_MAPPING	Do not add a side effect to this action
addAuthoringLayoutMappingAction
addAuthoringLayoutMappingIfNonExistentAction	Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addAuthoringLayoutMappingAction.
AUTH_LAYOUT_MAPPING_FEATURE
authLayoutMappingFeatureReducer
authoringLayoutMappingFeature	Exposes the feature module selector
authoringLayoutMappingReducer	reducers for authoring content
guaranteeAuthoringLayoutMappingAction
guaranteeAuthoringLayoutMappingByTypeAction
loadAuthoringLayoutMappingAction
selectAuthLayoutMappingFeature	Select the authoring type feature
selectAuthoringLayoutMapping
selectAuthoringLayoutMappingByTypeId
setAuthoringLayoutMappingAction
VERSION	Version and build number of the package

Type Aliases

Type Alias	Description
AddAuthoringLayoutMappingAction
AddAuthoringLayoutMappingIfNonExistentAction
AuthoringLayoutMappingState
GuaranteeAuthoringLayoutMappingAction
GuaranteeAuthoringLayoutMappingByTypeAction
LoadAuthoringLayoutMappingAction
SetAuthoringLayoutMappingAction

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

AuthLayoutMappingFeatureState interface

Signature:

export interface AuthLayoutMappingFeatureState 

Properties

Property	Type	Description
authLayoutMapping	AuthoringLayoutMappingState

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

ACTION_ADD_AUTH_LAYOUT_MAPPING_IF_NONEXISTENT variable

Signature:

ACTION_ADD_AUTH_LAYOUT_MAPPING_IF_NONEXISTENT = "ACTION_ADD_AUTH_LAYOUT_MAPPING_IF_NONEXISTENT"

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

ACTION_ADD_AUTH_LAYOUT_MAPPING variable

Signature:

ACTION_ADD_AUTH_LAYOUT_MAPPING = "ACTION_ADD_AUTH_LAYOUT_MAPPING"

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

ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING_BY_TYPE variable

Signature:

ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING_BY_TYPE = "ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING_BY_TYPE"

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

ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING variable

Signature:

ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING = "ACTION_GUARANTEE_AUTH_LAYOUT_MAPPING"

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

ACTION_LOAD_AUTH_LAYOUT_MAPPING variable

Signature:

ACTION_LOAD_AUTH_LAYOUT_MAPPING = "ACTION_LOAD_AUTH_LAYOUT_MAPPING"

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

ACTION_SET_AUTH_LAYOUT_MAPPING variable

Do not add a side effect to this action

Signature:

ACTION_SET_AUTH_LAYOUT_MAPPING = "ACTION_SET_AUTH_LAYOUT_MAPPING"

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

addAuthoringLayoutMappingAction variable

Signature:

addAuthoringLayoutMappingAction: UnaryFunction<AuthoringLayoutMapping, AddAuthoringLayoutMappingAction>

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

addAuthoringLayoutMappingIfNonExistentAction 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 addAuthoringLayoutMappingAction.

Signature:

addAuthoringLayoutMappingIfNonExistentAction: UnaryFunction<AuthoringLayoutMapping, AddAuthoringLayoutMappingIfNonExistentAction>

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

AUTH_LAYOUT_MAPPING_FEATURE variable

Signature:

AUTH_LAYOUT_MAPPING_FEATURE = "authLayoutMapping"

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

authLayoutMappingFeatureReducer variable

Signature:

authLayoutMappingFeatureReducer: {
    authLayoutMapping: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutMapping>, import("./auth.layout.mapping.actions").AddAuthoringLayoutMappingAction | import("./auth.layout.mapping.actions").SetAuthoringLayoutMappingAction>;
}

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

authoringLayoutMappingFeature variable

Exposes the feature module selector

Signature:

authoringLayoutMappingFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutMapping>, AuthLayoutMappingFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

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

authoringLayoutMappingReducer variable

reducers for authoring content

Signature:

authoringLayoutMappingReducer: Reducer<AuthoringLayoutMappingState, AddAuthoringLayoutMappingAction | SetAuthoringLayoutMappingAction>

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

guaranteeAuthoringLayoutMappingAction variable

Signature:

guaranteeAuthoringLayoutMappingAction: UnaryFunction<string, GuaranteeAuthoringLayoutMappingAction>

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

guaranteeAuthoringLayoutMappingByTypeAction variable

Signature:

guaranteeAuthoringLayoutMappingByTypeAction: UnaryFunction<string, GuaranteeAuthoringLayoutMappingByTypeAction>

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

loadAuthoringLayoutMappingAction variable

Signature:

loadAuthoringLayoutMappingAction: UnaryFunction<string, LoadAuthoringLayoutMappingAction>

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

selectAuthLayoutMappingFeature variable

Select the authoring type feature

Signature:

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

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

selectAuthoringLayoutMapping variable

Signature:

selectAuthoringLayoutMapping: UnaryFunction<string, UnaryFunction<AuthoringLayoutMappingState, AuthoringLayoutMapping>>

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

selectAuthoringLayoutMappingByTypeId variable

Signature:

selectAuthoringLayoutMappingByTypeId: UnaryFunction<string, UnaryFunction<AuthoringLayoutMappingState, AuthoringLayoutMapping>>

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

setAuthoringLayoutMappingAction variable

Signature:

setAuthoringLayoutMappingAction: UnaryFunction<AuthoringLayoutMapping, SetAuthoringLayoutMappingAction>

Home > @acoustic-content-sdk/redux-feature-auth-layout-mapping > 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-mapping > AuthoringLayoutMappingState

AuthoringLayoutMappingState type

Signature:

export declare type AuthoringLayoutMappingState = Record<string, AuthoringLayoutMapping>;

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

AuthLayoutMappingFeatureState.authLayoutMapping property

Signature:

[AUTH_LAYOUT_MAPPING_FEATURE]: AuthoringLayoutMappingState;