RSX Code Reference
    Preparing search index...
    • rsx
    • ImportFileInformation

    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.

    Index
    constructor
    errorMessage filePath isFailed optimalImportOptions polyverseData sourceData
    destroy
    • get errorMessage(): string

      The error message, if pre-import failed.

      Returns string

    • set errorMessage(value: string): void

      Parameters

      • value: string

      Returns void

    • 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: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get polyverseData(): JsonObject

      Polyverse specific data. Set when importing data from Polyverse.

      Returns JsonObject

    • set polyverseData(value: JsonObject): void

      Parameters

      Returns void

    • Destroys the file information and releases all data.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods