Method AddVariantAsync
AddVariantAsync(FileId, string, IFileProcessingPipelineSelector, CancellationToken)
Adds a new file variant (and any nested auto-variants declared by the pipeline) to an existing file in the repository.
Declaration
public Task<IReadOnlyList<RepoFileInfo>> AddVariantAsync(FileId fileId, string variantId, IFileProcessingPipelineSelector pipeline, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| FileId | fileId | The ID of the main file to which the variant will be added. |
| string | variantId | The ID of the top-level variant to be added. |
| IFileProcessingPipelineSelector | pipeline | The pipeline provider used to process the top-level variant. |
| CancellationToken | cancellationToken | A cancellation token that cancels the operation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<RepoFileInfo>> | The list of stored variants in pre-order (top-level first, then nested in declaration order). Variants whose pipelines stored an alias due to AliasWhenVariantSourceUnchanged are included in the list with the resolved data file path. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | A variant in the requested tree already exists. |
AddVariantAsync(FileId, string, string?, IFileProcessingPipelineSelector, CancellationToken)
Adds a new file variant (and any nested auto-variants declared by the pipeline) to an existing file in the repository.
Declaration
public Task<IReadOnlyList<RepoFileInfo>> AddVariantAsync(FileId fileId, string variantId, string? sourceVariantId, IFileProcessingPipelineSelector pipeline, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| FileId | fileId | The ID of the main file to which the variant will be added. |
| string | variantId | The ID of the top-level variant to be added. |
| string | sourceVariantId | The ID of the source variant, or null to use the main file as the source. |
| IFileProcessingPipelineSelector | pipeline | The pipeline provider used to process the top-level variant. |
| CancellationToken | cancellationToken | A cancellation token that cancels the operation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<RepoFileInfo>> | The list of stored variants in pre-order (top-level first, then nested in declaration order). Variants whose pipelines stored an alias due to AliasWhenVariantSourceUnchanged are included in the list with the resolved data file path. |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | A variant in the requested tree already exists. |