Implementation of the feature store that manages content items.

API Documentation

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

redux-feature-auth-content package

Implementation of a redux feature to manage authoring content.

Functions

| Function | Description | | --- | --- | | isAuthoringContentItem(aValue) | |

Interfaces

| Interface | Description | | --- | --- | | AuthContentEmbedItemPayload | | | AuthContentFeatureState | | | AuthContentPropertyUpdatePayload | |

Variables

| Variable | Description | | --- | --- | | ACTION_ADD_AUTH_CONTENT_IF_NONEXISTENT | | | ACTION_ADD_AUTH_CONTENT | | | ACTION_AUTH_CONTENT_EMBED_ITEM | | | ACTION_AUTH_CONTENT_PROPERTY_UPDATE | | | ACTION_GUARANTEE_AUTH_CONTENT | | | ACTION_LOAD_AUTH_CONTENT | | | ACTION_REMOVE_AUTH_CONTENT | | | ACTION_SAVE_AUTH_CONTENT_BATCH | | | ACTION_SAVE_AUTH_CONTENT | | | ACTION_SET_AUTH_CONTENT | Do not add a side effect to this action | | addAuthoringContentAction | | | addAuthoringContentIfNonExistentAction | Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addAuthoringContentAction. | | AUTH_CONTENT_FEATURE | | | authContentEmbedItem | | | authContentFeatureReducer | | | authContentPropertyUpdateAction | | | authoringContentFeature | Exposes the feature module selector | | authoringContentReducer | reducers for authoring content | | guaranteeAuthoringContentAction | Loads the content item if it does not exist. If the item does not exist, this triggers a loadAuthoringContentAction. | | loadAuthoringContentAction | | | migrateContentItems | | | MODULE | Module name | | removeAuthoringContentAction | | | saveAuthoringContentAction | | | saveAuthoringContentBatchAction | | | selectAuthContentFeature | Select the auth.contenting feature | | selectAuthoringContentItem | | | setAuthoringContentAction | | | VERSION | Version and build number of the package |

Type Aliases

| Type Alias | Description | | --- | --- | | AddAuthoringContentAction | | | AddAuthoringContentIfNonExistentAction | | | AuthContentEmbedItemAction | | | AuthContentPropertyUpdateAction | | | AuthoringContentActions | | | AuthoringContentActionsPayload | | | AuthoringContentBatchItems | | | AuthoringContentSaveItem | | | AuthoringContentState | | | GuaranteeAuthoringContentAction | | | LoadAuthoringContentAction | | | RemoveAuthoringContentAction | | | SaveAuthoringContentAction | | | SaveAuthoringContentBatchAction | | | SetAuthoringContentAction | |

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

isAuthoringContentItem() function

Signature:

export declare function isAuthoringContentItem(aValue: any): aValue is AuthoringContentItem;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aValue | any | |

Returns:

aValue is AuthoringContentItem

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

AuthContentEmbedItemPayload interface

Signature:

export interface AuthContentEmbedItemPayload 

Properties

| Property | Type | Description | | --- | --- | --- | | accessor | AccessorType | | | bInsert | boolean | | | id | AuthoringContentItem | string | | | item | AuthoringContentItem | string | |

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

AuthContentFeatureState interface

Signature:

export interface AuthContentFeatureState 

Properties

| Property | Type | Description | | --- | --- | --- | | authContent | AuthoringContentState | |

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

AuthContentPropertyUpdatePayload interface

Signature:

export interface AuthContentPropertyUpdatePayload 

Properties

| Property | Type | Description | | --- | --- | --- | | accessor | AccessorType | | | id | string | | | value | any | |

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

ACTION_ADD_AUTH_CONTENT_IF_NONEXISTENT variable

Signature:

ACTION_ADD_AUTH_CONTENT_IF_NONEXISTENT = "ACTION_ADD_AUTH_CONTENT_IF_NONEXISTENT"

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

ACTION_ADD_AUTH_CONTENT variable

Signature:

ACTION_ADD_AUTH_CONTENT = "ACTION_ADD_AUTH_CONTENT"

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

ACTION_AUTH_CONTENT_EMBED_ITEM variable

Signature:

ACTION_AUTH_CONTENT_EMBED_ITEM = "ACTION_AUTH_CONTENT_EMBED_ITEM"

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

ACTION_AUTH_CONTENT_PROPERTY_UPDATE variable

Signature:

ACTION_AUTH_CONTENT_PROPERTY_UPDATE = "ACTION_AUTH_CONTENT_PROPERTY_UPDATE"

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

ACTION_GUARANTEE_AUTH_CONTENT variable

Signature:

ACTION_GUARANTEE_AUTH_CONTENT = "ACTION_GUARANTEE_AUTH_CONTENT"

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

ACTION_LOAD_AUTH_CONTENT variable

Signature:

ACTION_LOAD_AUTH_CONTENT = "ACTION_LOAD_AUTH_CONTENT"

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

ACTION_REMOVE_AUTH_CONTENT variable

Signature:

ACTION_REMOVE_AUTH_CONTENT = "ACTION_REMOVE_AUTH_CONTENT"

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

ACTION_SAVE_AUTH_CONTENT_BATCH variable

Signature:

ACTION_SAVE_AUTH_CONTENT_BATCH = "ACTION_SAVE_AUTH_CONTENT_BATCH"

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

ACTION_SAVE_AUTH_CONTENT variable

Signature:

ACTION_SAVE_AUTH_CONTENT = "ACTION_SAVE_AUTH_CONTENT"

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

ACTION_SET_AUTH_CONTENT variable

Do not add a side effect to this action

Signature:

ACTION_SET_AUTH_CONTENT = "ACTION_SET_AUTH_CONTENT"

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

addAuthoringContentAction variable

Signature:

addAuthoringContentAction: UnaryFunction<AuthoringContentItem, AddAuthoringContentAction>

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

addAuthoringContentIfNonExistentAction 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 addAuthoringContentAction.

Signature:

addAuthoringContentIfNonExistentAction: UnaryFunction<AuthoringContentItem, AddAuthoringContentIfNonExistentAction>

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

AUTH_CONTENT_FEATURE variable

Signature:

AUTH_CONTENT_FEATURE = "authContent"

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

authContentEmbedItem variable

Signature:

authContentEmbedItem: UnaryFunction<AuthContentEmbedItemPayload, AuthContentEmbedItemAction>

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

authContentFeatureReducer variable

Signature:

authContentFeatureReducer: {
    authContent: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").AuthoringContentItem>, import("./auth.content.actions").AuthoringContentActions>;
}

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

authContentPropertyUpdateAction variable

Signature:

authContentPropertyUpdateAction: (id: string, accessor: string, value: any) => AuthContentPropertyUpdateAction

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

authoringContentFeature variable

Exposes the feature module selector

Signature:

authoringContentFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").AuthoringContentItem>, AuthContentFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

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

authoringContentReducer variable

reducers for authoring content

Signature:

authoringContentReducer: Reducer<AuthoringContentState, AuthoringContentActions>

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

guaranteeAuthoringContentAction variable

Loads the content item if it does not exist. If the item does not exist, this triggers a loadAuthoringContentAction.

Signature:

guaranteeAuthoringContentAction: UnaryFunction<string, GuaranteeAuthoringContentAction>

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

loadAuthoringContentAction variable

Signature:

loadAuthoringContentAction: UnaryFunction<string, LoadAuthoringContentAction>

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

migrateContentItems variable

Signature:

migrateContentItems: (contentItems: AuthoringContentItem[]) => AuthoringContentItem[]

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

MODULE variable

Module name

Signature:

MODULE = "@acoustic-content-sdk/redux-feature-auth-content"

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

removeAuthoringContentAction variable

Signature:

removeAuthoringContentAction: UnaryFunction<string, RemoveAuthoringContentAction>

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

saveAuthoringContentAction variable

Signature:

saveAuthoringContentAction: UnaryFunction<AuthoringContentSaveItem, SaveAuthoringContentAction>

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

saveAuthoringContentBatchAction variable

Signature:

saveAuthoringContentBatchAction: UnaryFunction<AuthoringContentBatchItems, SaveAuthoringContentBatchAction>

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

selectAuthContentFeature variable

Select the auth.contenting feature

Signature:

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

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

selectAuthoringContentItem variable

Signature:

selectAuthoringContentItem: UnaryFunction<string, UnaryFunction<AuthoringContentState, AuthoringContentItem>>

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

setAuthoringContentAction variable

Signature:

setAuthoringContentAction: UnaryFunction<AuthoringContentItem, SetAuthoringContentAction>

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

AuthContentEmbedItemAction type

Signature:

export declare type AuthContentEmbedItemAction = PayloadAction<AuthContentEmbedItemPayload>;

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

AuthoringContentActions type

Signature:

export declare type AuthoringContentActions = AddAuthoringContentAction | SetAuthoringContentAction | RemoveAuthoringContentAction;

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

AuthoringContentActionsPayload type

Signature:

export declare type AuthoringContentActionsPayload = AuthoringContentItem | string;

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

AuthoringContentBatchItems type

Signature:

export declare type AuthoringContentBatchItems = AuthoringContentSaveItem[];

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

AuthoringContentSaveItem type

Signature:

export declare type AuthoringContentSaveItem = AuthoringContentItem | string;

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

AuthoringContentState type

Signature:

export declare type AuthoringContentState = Record<string, AuthoringContentItem>;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentEmbedItemPayload > accessor

AuthContentEmbedItemPayload.accessor property

Signature:

accessor: AccessorType;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentEmbedItemPayload > bInsert

AuthContentEmbedItemPayload.bInsert property

Signature:

bInsert?: boolean;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentEmbedItemPayload > id

AuthContentEmbedItemPayload.id property

Signature:

id: AuthoringContentItem | string;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentEmbedItemPayload > item

AuthContentEmbedItemPayload.item property

Signature:

item: AuthoringContentItem | string;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentPropertyUpdatePayload > accessor

AuthContentPropertyUpdatePayload.accessor property

Signature:

accessor: AccessorType;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentPropertyUpdatePayload > id

AuthContentPropertyUpdatePayload.id property

Signature:

id: string;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentPropertyUpdatePayload > value

AuthContentPropertyUpdatePayload.value property

Signature:

value: any;

Home > @acoustic-content-sdk/redux-feature-auth-content > AuthContentFeatureState > authContent

AuthContentFeatureState.authContent property

Signature:

[AUTH_CONTENT_FEATURE]: AuthoringContentState;