Constructor ComponentConfig

Namespace: Phoenix.Pacz
Assembly: Phoenix.Pacz.dll

ComponentConfig(Guid, RunFolderPreference, IReadOnlyList<RuntimeVariable>, IReadOnlyList<RuntimeVariable>, string, string, IReadOnlyList, IEnumerable<InstanceFile>, IEnumerable<ExternalFile>, IReadOnlyList<Compatibility>, IDictionary<string, object>, Uri, Uri, string, string)

Constructor

[JsonConstructor]
public ComponentConfig(Guid plugInId, RunFolderPreference rfp, IReadOnlyList<RuntimeVariable> inputs, IReadOnlyList<RuntimeVariable> outputs, string version = null, string description = null, IReadOnlyList<string> requires = null, IEnumerable<InstanceFile> instanceFiles = null, IEnumerable<ExternalFile> externalFiles = null, IReadOnlyList<Compatibility> compatibilities = null, IDictionary<string, object> properties = null, Uri icon = null, Uri help = null, string asComponent = null, string author = null)

Parameters

plugInId Guid

The UUID of the plug-in that generated this Pacz

rfp RunFolderPreference

The RunFolderPreference for this Pacz

inputs IReadOnlyList<RuntimeVariable>

A list of the available inputs for this Pacz

outputs IReadOnlyList<RuntimeVariable>

A list of the available outputs for this Pacz

version string

The version of this Pacz. The framework merely reports this as a string and does not use any semantic parsing of the version string.

description string

A description of the Pacz

requires IReadOnlyList<string>

A list of requirements to run this Pacz

instanceFiles IEnumerable<InstanceFile>

A list of files to be included in the compressed pacz.

externalFiles IEnumerable<ExternalFile>

A list of external files that the component references.

compatibilities IReadOnlyList<Compatibility>

This parameter is for internal use. Leave it null

properties IDictionary<string, object>

An arbitrary dictionary of values that allows a plug-in writer to store data about the instance without needing to create additional files in the Pacz.

icon Uri

The file relative to the .pacj file (usually stored in the .pacz file) to be used as an icon

help Uri

URI of help to use for component

asComponent string

Legacy field. Leave it null

author string

The author of this component

ComponentConfig(IReadOnlyComponentConfig)

Copy constructor. Creates a ComponentConfig that is a clone of the source.

public ComponentConfig(IReadOnlyComponentConfig source)

Parameters

source IReadOnlyComponentConfig

The source to copy from