Class ImportFileInformation

The ImportFileInformation struct contains information for a pending import operation. The object is typically the result of a ProjectLibrary::PeekFile operation and may contain cache for the data that is about to be imported. The structure can also be used to inject data into the import operation such as polyverseData. Injected data will be applied to the imported sub resources, if the import operation was successful.

Hierarchy

  • FrameworkObject
    • ImportFileInformation

Constructors

constructor

Accessors

errorMessage filePath isFailed optimalImportOptions polyverseData sourceData

Methods

destroy

Constructors

Protectedconstructor

Accessors

errorMessage

  • get errorMessage(): string

  • The error message, if pre-import failed.

    Returns string

  • set errorMessage(value): void

  • Parameters

    • value: string

    Returns void

filePath

  • get filePath(): FilePath

  • The absolute path to the file.

    Returns FilePath

  • set filePath(value): void

  • Parameters

    Returns void

isFailed

  • get isFailed(): boolean

  • A bool to indicate whether the pre-importation failed. If so, it shouldn't try to import the file.

    Returns boolean

  • set isFailed(value): void

  • Parameters

    • value: boolean

    Returns void

optimalImportOptions

polyverseData

  • get polyverseData(): JsonObject

  • Polyverse specific data. Set when importing data from Polyverse.

    Returns JsonObject

  • set polyverseData(value): void

  • Parameters

    Returns void

sourceData

Methods

destroy

  • destroy(): void

  • Destroys the file information and releases all data.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods