Download full document:

Import Class

Represents an import as it progresses.

Inheritance Hierarchy

System.Object
  Citrix.SDK.AppDNA.Import
Namespace: Citrix.SDK.AppDNA
Assembly: Citrix.SDK.AppDNA (in Citrix.SDK.AppDNA.dll) Version: 7.11.0.0 (7.11.0.0)

Syntax

C

public class Import : IDisposable

VB

Public Class Import
    Implements IDisposable

The Import type exposes the following members.

Properties

 

NameDescription
Public propertyIsFinished Returns true if the client-side processing is complete. The return value of this does not indicate success, error or cancellation, simply whether or not the client-side processing is complete.
  Back to Top

Methods

 

NameDescription
Public methodCancel Requests that the specified import sources cancel both on the client and on the server side. Also, call this method to cancel work (e.g. Web Spider capturing) before the actual import has started.
Public methodDispose Halts the import and releases resources. Failure to dispose of this object may leak resources.
Public methodEquals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetApplication(IImportDetails) Returns the Application object resulting from the import defined by details.
Public methodGetApplication(IImportDetails, TimeSpan) Returns the Application object resulting from the import defined by details.
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodGetLogFilePath Returns the full path to the text log file that holds the log of the import defined by details.
Public methodGetOutputDirectory Returns the Output directory which is to contain install capture files, which is generated on the fly (with timestamp + application name).
Public methodGetProcessingState Returns the ProcessingState object that represents the state of the import defined by details.
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodRequestCancel Requests that the current import stops. IsFinished is set to true subsequently, not immediately.
Public methodToString Returns a string that represents the current object. (Inherited from Object.)
Public methodWaitForCompletion() Returns when IsFinished is true.
Public methodWaitForCompletion(TimeSpan) Returns true if IsFinished is true before timeout elapses.
  Back to Top

Events

 

NameDescription
Public eventAnalysisStarted This event is raised when the analysis is started automatically after applications are imported.
Public eventApplicationImportStateChanged This event is raised when the server-side ProcessingState of an application being imported has changed.
Public eventFileImportStateChanged This event is raised when the ProcessingState of one of the imports managed by this object has changed.
Public eventFinished This event is raised when IsFinished becomes true or the event is subscribed to when IsFinished is already true.
  Back to Top

Remarks

An Import object is obtained by calling one of the Application.Import function overloads. It drives the import, providing status information and access to the completed import. An import consists of 2 phases. The first is client side preparation and analysis. The second phase is server side analysis and data storage. The WaitForCompletion function is used to determine when the client side phase is complete. If server side queuing is disabled, this also coincides with the completion of the server side phase. If server side queuing is enabled, then WaitForCompletion will return before all applications are fully loaded at the server. However calling the GetApplication function for a given IImportDetails will not return until the server phase is complete for that application.

See Also

Reference

Citrix.SDK.AppDNA Namespace