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

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:

batchFeature: import("@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:

createAssetAndReplaceReferenceAction: UnaryFunction<CreateAssetAndReplaceReferencePayload, CreateAssetAndReplaceReferenceAction>

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

guaranteeAuthoringContentBatchAction variable

Makes sure to preload items as fast as possible

Signature:

guaranteeAuthoringContentBatchAction: UnaryFunction<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: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

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:

accessor: string;

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:

assetId: string;

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

CreateAssetAndReplaceReferencePayload.contentItemId property

The content item to update.

Signature:

contentItemId: string;

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

CreateAssetAndReplaceReferencePayload.file property

The file to upload.

Signature:

file: File;