@acoustic-content-sdk/redux-feature-batch 中文文档教程

Question

API 文档

@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

< a href="#_52319b423c53d0bca69be882ce2fbb251957d1707ef3cfde89d3d9f819b6770c">主页 > @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 Exposes

batchFeature variable

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

为提供的内容创建资产并使用提供的 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>

主页 > @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;
}

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

CreateAssetAndReplaceReferencePayload.accessor property

指向需要使用资产 ID 更新的内容属性的访问器字符串（例如 elements.image.id）。

Signature:

accessor: string;

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

CreateAssetAndReplaceReferencePayload.asset property

可选的用作基线的资产。 该操作将从该资产复制相关元数据。

Signature:

asset?: AuthoringAsset;

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

CreateAssetAndReplaceReferencePayload.assetId property

要创建的资产的 ID。 通常这是在客户端自动生成的 ID。

Signature:

assetId: string;

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

CreateAssetAndReplaceReferencePayload.contentItemId property

要更新的内容项。

Signature:

contentItemId: string;

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

CreateAssetAndReplaceReferencePayload.file property

要上传的文件。

签名：

file: File;