Interface ProductCatalogEditor.IProductCatalogExporter

Product catalog exporters implement this interface to provide validation and export of a ProductCatalog.

Namespace: UnityEditor.Purchasing

Syntax

public interface IProductCatalogExporter

Properties

DefaultFileName

The default file name of the catalog export.

Declaration

string DefaultFileName { get; }

Property Value

Type	Description
String

DisplayName

The display name of the catalog.

Declaration

string DisplayName { get; }

Property Value

Type	Description
String

FileExtension

The file extension of the catalog export.

Declaration

string FileExtension { get; }

Property Value

Type	Description
String

FilesToCopy

Files to copy to the final directory, ex. screenshots on iOS

Declaration

List<string> FilesToCopy { get; }

Property Value

Type	Description
List<String>

MandatoryExportFolder

Required specific path for output file. Is optional whether user will be permitted to save a copy to a separate path in addition to this required path.

Declaration

string MandatoryExportFolder { get; }

Property Value

Type	Description
String

SaveCompletePackage

True if the exporter should save an entire package/folder (specified by MandatoryExportFolder and FilesToCopy, not just a single file. This will present a Directory picker, not a File picker. The DefaultFileName will be used for the main file in the MandatoryExportFolder, and any FilesToCopy will be placed in that folder as well.

Declaration

bool SaveCompletePackage { get; }

Property Value

Type	Description
Boolean

StoreName

The name of the store to be exported.

Declaration

string StoreName { get; }

Property Value

Type	Description
String

Methods

Export(ProductCatalog)

Exports the product catalog.

Declaration

string Export(ProductCatalog catalog)

Parameters

Type	Name	Description
ProductCatalog	catalog	The ProductCatalog to be exported.

Returns

Type	Description
String	The exported catalog as raw text.

NormalizeToType(ProductCatalog)

Normalizes the product catalog for export to the base type. Fixes issues targeting this exporter's implempentation.

Declaration

ProductCatalog NormalizeToType(ProductCatalog catalog)

Parameters

Type	Name	Description
ProductCatalog	catalog	The ProductCatalog to be normalized.

Returns

Type	Description
ProductCatalog	The normalized ProductCatalog.

Validate(ProductCatalog)

Validates the product catalog for export.

Declaration

ProductCatalogEditor.ExporterValidationResults Validate(ProductCatalog catalog)

Parameters

Type	Name	Description
ProductCatalog	catalog	The ProductCatalog to be exported.

Returns

Type	Description
ProductCatalogEditor.ExporterValidationResults	The results of the validation.

Validate(ProductCatalogItem)

Validates the product catalog item for export.

Declaration

ProductCatalogEditor.ExporterValidationResults Validate(ProductCatalogItem item)

Parameters

Type	Name	Description
ProductCatalogItem	item	The ProductCataloItemg to be exported.

Returns

Type	Description
ProductCatalogEditor.ExporterValidationResults	The results of the validation.