Wondering what’s next for npm?Check out our public roadmap! »

    @acoustic-content-sdk/redux-feature-batch
    TypeScript icon, indicating that this package has built-in type declarations

    9.0.10076 • Public • Published

    npm

    API Documentation

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

    redux-feature-batch package

    Interfaces

    Interface Description
    CreateAssetAndReplaceReferencePayload

    Variables

    Variable Description
    batchFeature Exposes the feature module selector
    createAssetAndReplaceReferenceAction Implementation of an action that creates an asset for the provided and replaces the asset reference in the content item with the provided id.
    guaranteeAuthoringContentBatchAction Makes sure to preload items as fast as possible
    MODULE Module name
    VERSION Version and build number of the package

    Type Aliases

    Type Alias Description
    CreateAssetAndReplaceReferenceAction
    GuaranteeAuthoringContentBatchAction

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload

    CreateAssetAndReplaceReferencePayload interface

    Signature:

    export interface CreateAssetAndReplaceReferencePayload 

    Properties

    Property Type Description
    accessor string The accessor string (e.g. elements.image.id) that points to the content property that needs to be updated with the asset id.
    asset AuthoringAsset Optionally an asset that is used as a baseline. The action will copy the relevant metadata from this asset.
    assetId string The id of the asset to create. Typcially this is an auto generated ID on the client side.
    contentItemId string The content item to update.
    file File The file to upload.

    Home > @acoustic-content-sdk/redux-feature-batch > batchFeature

    batchFeature variable

    Exposes the feature module selector

    Signature:

    batchFeatureimport("@acoustic-content-sdk/redux-store").ReduxFeatureModule<unknown, any, import("redux").AnyAction, import("redux").AnyAction, any>

    Home > @acoustic-content-sdk/redux-feature-batch > createAssetAndReplaceReferenceAction

    createAssetAndReplaceReferenceAction variable

    Implementation of an action that creates an asset for the provided and replaces the asset reference in the content item with the provided id.

    Signature:

    createAssetAndReplaceReferenceActionUnaryFunction<CreateAssetAndReplaceReferencePayload, CreateAssetAndReplaceReferenceAction>

    Home > @acoustic-content-sdk/redux-feature-batch > guaranteeAuthoringContentBatchAction

    guaranteeAuthoringContentBatchAction variable

    Makes sure to preload items as fast as possible

    Signature:

    guaranteeAuthoringContentBatchActionUnaryFunction<string | string[], GuaranteeAuthoringContentBatchAction>

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

    MODULE variable

    Module name

    Signature:

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

    Home > @acoustic-content-sdk/redux-feature-batch > VERSION

    VERSION variable

    Version and build number of the package

    Signature:

    VERSION{
        version{
            majorstring;
            minorstring;
            patchstring;
            branchstring;
        };
        buildDate;
    }

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload > accessor

    CreateAssetAndReplaceReferencePayload.accessor property

    The accessor string (e.g. elements.image.id) that points to the content property that needs to be updated with the asset id.

    Signature:

    accessorstring;

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload > asset

    CreateAssetAndReplaceReferencePayload.asset property

    Optionally an asset that is used as a baseline. The action will copy the relevant metadata from this asset.

    Signature:

    asset?: AuthoringAsset;

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload > assetId

    CreateAssetAndReplaceReferencePayload.assetId property

    The id of the asset to create. Typcially this is an auto generated ID on the client side.

    Signature:

    assetIdstring;

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload > contentItemId

    CreateAssetAndReplaceReferencePayload.contentItemId property

    The content item to update.

    Signature:

    contentItemIdstring;

    Home > @acoustic-content-sdk/redux-feature-batch > CreateAssetAndReplaceReferencePayload > file

    CreateAssetAndReplaceReferencePayload.file property

    The file to upload.

    Signature:

    fileFile;

    Install

    npm i @acoustic-content-sdk/redux-feature-batch

    DownloadsWeekly Downloads

    2

    Version

    9.0.10076

    License

    MIT

    Unpacked Size

    621 kB

    Total Files

    60

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar