Interface IImporter

Namespace: LemonEdge.API.Core.Processors.Importing
Assembly: LemonEdge.API.dll
Syntax
public interface IImporter

Properties

ProgressReporter

An interface for reporting the progress, or status, of the import back to the client or a log

Declaration
IProgressReporter ProgressReporter { get; }
Property Value
Type Description
IProgressReporter

Methods

ImportData(IEntityUpdater, bool, bool, bool, CancellationToken)

Imports the data specified using InitDataForImport(byte[]) according to the specified parameters

Leaves progress as 95% complete for saving if in batch/extra work/etc

Declaration
Task<IEnumerable<ImportLineResultInfo>> ImportData(IEntityUpdater updater, bool saveSequentially, bool validate, bool bypassProcessors, CancellationToken cancel = default)
Parameters
Type Name Description
IEntityUpdater updater

The current context of updater to use for importing/updating and committing the data
bool saveSequentially

Indicates the data should be saved and committed to the database. Creates a new context for each item to import.

If this is false, the data is just all imported into the updater context, but is not saved. That needs to be done externally by the calling function.

bool validate
bool bypassProcessors
CancellationToken cancel

A cancellation token to stop importing the data
Returns
Type Description
Task<IEnumerable<ImportLineResultInfo>>

A task representing the completion of the operation with a list of information for each item imported

Extension Methods