Implementation of the feature store that manages content types.

API Documentation

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

redux-feature-auth-type package

Implementation of a redux feature to manage authoring types.

Functions

| Function | Description | | --- | --- | | rxElementType(aAuthoringTypes$, aLogger, aScheduler) | Resolves the element type, either directly from the element or from the authoring type |

Interfaces

| Interface | Description | | --- | --- | | AuthTypeFeatureState | |

Variables

| Variable | Description | | --- | --- | | ACTION_ADD_AUTH_CONTENT_TYPE_IF_NONEXISTENT | | | ACTION_ADD_AUTH_CONTENT_TYPE | | | ACTION_GUARANTEE_AUTH_CONTENT_TYPE | | | ACTION_LOAD_AUTH_CONTENT_TYPE | | | ACTION_SET_AUTH_CONTENT_TYPE | Do not add a side effect to this action | | addAuthoringContentTypeAction | | | addAuthoringContentTypeIfNonExistentAction | Adds this content type to the store only if the type does not exist, yet. If the type does not exist, this triggers a addAuthoringContentTypeAction. | | AUTH_TYPE_FEATURE | | | authoringTypeFeature | Exposes the feature module selector | | authoringTypeReducer | reducers for templates | | authTypeFeatureReducer | | | guaranteeAuthoringContentTypeAction | Loads the content type if it does not exist. If the type does not exist, this triggers a loadAuthoringContentTypeAction. | | loadAuthoringContentTypeAction | | | selectAuthType | | | selectAuthTypeFeature | Select the authoring type feature | | setAuthoringContentTypeAction | | | VERSION | Version and build number of the package |

Type Aliases

| Type Alias | Description | | --- | --- | | AddAuthoringContentTypeAction | | | AddAuthoringContentTypeIfNonExistentAction | | | AuthoringTypeState | | | GuaranteeAuthoringContentTypeAction | | | LoadAuthoringContentTypeAction | | | SetAuthoringContentTypeAction | |

Home > @acoustic-content-sdk/redux-feature-auth-type > rxElementType

rxElementType() function

Resolves the element type, either directly from the element or from the authoring type

Signature:

export declare function rxElementType(aAuthoringTypes$: Observable<AuthoringTypeState>, aLogger: Logger, aScheduler?: SchedulerLike): UnaryFunction<AccessorType, OperatorFunction<RenderingContext, ELEMENT_TYPE>>;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aAuthoringTypes$ | Observable<AuthoringTypeState> | the set of available authoring types | | aLogger | Logger | optional logger | | aScheduler | SchedulerLike | optional scheduler |

Returns:

UnaryFunction<AccessorType, OperatorFunction<RenderingContext, ELEMENT_TYPE>>

the resolved type or undefined if the type could not be determined

Home > @acoustic-content-sdk/redux-feature-auth-type > AuthTypeFeatureState

AuthTypeFeatureState interface

Signature:

export interface AuthTypeFeatureState 

Properties

| Property | Type | Description | | --- | --- | --- | | authType | AuthoringTypeState | |

Home > @acoustic-content-sdk/redux-feature-auth-type > ACTION_ADD_AUTH_CONTENT_TYPE_IF_NONEXISTENT

ACTION_ADD_AUTH_CONTENT_TYPE_IF_NONEXISTENT variable

Signature:

ACTION_ADD_AUTH_CONTENT_TYPE_IF_NONEXISTENT = "ACTION_ADD_AUTH_CONTENT_TYPE_IF_NONEXISTENT"

Home > @acoustic-content-sdk/redux-feature-auth-type > ACTION_ADD_AUTH_CONTENT_TYPE

ACTION_ADD_AUTH_CONTENT_TYPE variable

Signature:

ACTION_ADD_AUTH_CONTENT_TYPE = "ACTION_ADD_AUTH_CONTENT_TYPE"

Home > @acoustic-content-sdk/redux-feature-auth-type > ACTION_GUARANTEE_AUTH_CONTENT_TYPE

ACTION_GUARANTEE_AUTH_CONTENT_TYPE variable

Signature:

ACTION_GUARANTEE_AUTH_CONTENT_TYPE = "ACTION_GUARANTEE_AUTH_CONTENT_TYPE"

Home > @acoustic-content-sdk/redux-feature-auth-type > ACTION_LOAD_AUTH_CONTENT_TYPE

ACTION_LOAD_AUTH_CONTENT_TYPE variable

Signature:

ACTION_LOAD_AUTH_CONTENT_TYPE = "ACTION_LOAD_AUTH_CONTENT_TYPE"

Home > @acoustic-content-sdk/redux-feature-auth-type > ACTION_SET_AUTH_CONTENT_TYPE

ACTION_SET_AUTH_CONTENT_TYPE variable

Do not add a side effect to this action

Signature:

ACTION_SET_AUTH_CONTENT_TYPE = "ACTION_SET_AUTH_CONTENT_TYPE"

Home > @acoustic-content-sdk/redux-feature-auth-type > addAuthoringContentTypeAction

addAuthoringContentTypeAction variable

Signature:

addAuthoringContentTypeAction: UnaryFunction<AuthoringType, AddAuthoringContentTypeAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > addAuthoringContentTypeIfNonExistentAction

addAuthoringContentTypeIfNonExistentAction variable

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

Signature:

addAuthoringContentTypeIfNonExistentAction: UnaryFunction<AuthoringType, AddAuthoringContentTypeIfNonExistentAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > AUTH_TYPE_FEATURE

AUTH_TYPE_FEATURE variable

Signature:

AUTH_TYPE_FEATURE = "authType"

Home > @acoustic-content-sdk/redux-feature-auth-type > authoringTypeFeature

authoringTypeFeature variable

Exposes the feature module selector

Signature:

authoringTypeFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").AuthoringType>, AuthTypeFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

Home > @acoustic-content-sdk/redux-feature-auth-type > authoringTypeReducer

authoringTypeReducer variable

reducers for templates

Signature:

authoringTypeReducer: Reducer<AuthoringTypeState, AddAuthoringContentTypeAction | SetAuthoringContentTypeAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > authTypeFeatureReducer

authTypeFeatureReducer variable

Signature:

authTypeFeatureReducer: {
    authType: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").AuthoringType>, import("./auth.type.actions").AddAuthoringContentTypeAction | import("./auth.type.actions").SetAuthoringContentTypeAction>;
}

Home > @acoustic-content-sdk/redux-feature-auth-type > guaranteeAuthoringContentTypeAction

guaranteeAuthoringContentTypeAction variable

Loads the content type if it does not exist. If the type does not exist, this triggers a loadAuthoringContentTypeAction.

Signature:

guaranteeAuthoringContentTypeAction: UnaryFunction<string, GuaranteeAuthoringContentTypeAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > loadAuthoringContentTypeAction

loadAuthoringContentTypeAction variable

Signature:

loadAuthoringContentTypeAction: UnaryFunction<string, LoadAuthoringContentTypeAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > selectAuthType

selectAuthType variable

Signature:

selectAuthType: UnaryFunction<string, UnaryFunction<AuthoringTypeState, AuthoringType>>

Home > @acoustic-content-sdk/redux-feature-auth-type > selectAuthTypeFeature

selectAuthTypeFeature variable

Select the authoring type feature

Signature:

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

Home > @acoustic-content-sdk/redux-feature-auth-type > setAuthoringContentTypeAction

setAuthoringContentTypeAction variable

Signature:

setAuthoringContentTypeAction: UnaryFunction<AuthoringType, SetAuthoringContentTypeAction>

Home > @acoustic-content-sdk/redux-feature-auth-type > 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-type > AuthoringTypeState

AuthoringTypeState type

Signature:

export declare type AuthoringTypeState = Record<string, AuthoringType>;

Home > @acoustic-content-sdk/redux-feature-auth-type > AuthTypeFeatureState > authType

AuthTypeFeatureState.authType property

Signature:

[AUTH_TYPE_FEATURE]: AuthoringTypeState;