IObjectImportProvider

Namespace: Lithnet.Ecma2Framework

Defines the methods and properties that an object import provider must implement

public interface IObjectImportProvider

Methods

InitializeAsync(ImportContext)

Initializes the object import provider. This method is called once at the start of an import operation

Task InitializeAsync(ImportContext context)

Parameters

context ImportContext The context of the operation

Returns

Task A task that represents the asynchronous operation

CanImportAsync(SchemaType)

Indicates whether the object import provider can import objects of the specified type

Task<bool> CanImportAsync(SchemaType type)

Parameters

type SchemaType The type of object to be imported

Returns

Task<Boolean> if the provider can import the object, otherwise

GetCSEntryChangesAsync(SchemaType, ICSEntryChangeCollection, String, CancellationToken)

Initiates the operation to import objects of the specified type. Created CSEntryChanges should be added to the provided ICSEntryChangeCollection object.

Task GetCSEntryChangesAsync(SchemaType type, ICSEntryChangeCollection csentryCollection, string incomingWatermark, CancellationToken cancellationToken)

Parameters

type SchemaType The type of object to import

csentryCollection ICSEntryChangeCollection The collection of CSEntryChange objects to add the imported objects to

incomingWatermark String The watermark value provided by the management agent after its last successful import

cancellationToken CancellationToken A cancellation token

Returns

Task A task that represents the asynchronous operation

GetOutboundWatermark(SchemaType, CancellationToken)

Gets the outbound watermark to save to the synchronization service at the completion of the import operation If the management agent doesn't support delta operations, then this method should return null

Task<string> GetOutboundWatermark(SchemaType type, CancellationToken cancellationToken)

Parameters

type SchemaType The object type to get the watermark for

cancellationToken CancellationToken A cancellation token

Returns

Task<String> The outbound watermark, or null if the management agent doesn't support delta operations