Class Package

Namespace

Dynamicweb.Deployment

Assembly

Dynamicweb.Core.dll

Reprensents a deployment package (zip file).

public class Package

Inheritance

object

Package

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Package(string)

Initializes a new instance of the Package class.

public Package(string filePath)

Parameters

filePath string

The file path.

Properties

PackageFilePath

Gets the package file path.

public string PackageFilePath { get; }

Property Value

string

The package file path.

Methods

ReadDataGroup(string)

Reads the data group.

public DataGroup? ReadDataGroup(string dataGroupId)

Parameters

dataGroupId string

The data group identifier.

Returns

DataGroup

DataGroup.

ReadDataGroups()

Reads the data groups.

public IEnumerable<DataGroup> ReadDataGroups()

Returns

IEnumerable<DataGroup>

IEnumerable<DataGroup>.

ReadDataItems(string, string)

Reads the data items.

public IEnumerable<DataItem> ReadDataItems(string dataGroupId, string dataItemTypeId)

Parameters

dataGroupId string

The data group identifier.

dataItemTypeId string

The data item type identifier.

Returns

IEnumerable<DataItem>

IEnumerable<DataItem>.

ReadDataItems(string, string, IEnumerable<string>)

Reads the data items.

public IEnumerable<DataItem> ReadDataItems(string dataGroupId, string dataItemTypeId, IEnumerable<string> itemIds)

Parameters

dataGroupId string

The data group identifier.

dataItemTypeId string

The data item type identifier.

itemIds IEnumerable<string>

The item ids.

Returns

IEnumerable<DataItem>

IEnumerable<DataItem>.

ReadPackageInfo()

Reads the package information.

public PackageInfo? ReadPackageInfo()

Returns

PackageInfo

WriteDataGroup(DataGroup)

Writes the data group.

public void WriteDataGroup(DataGroup dataGroup)

Parameters

dataGroup DataGroup

The data group.

WriteDataItems(string, string, IEnumerable<DataItem>)

Writes the data items.

public int WriteDataItems(string dataGroupId, string dataItemTypeId, IEnumerable<DataItem> dataItems)

Parameters

dataGroupId string

The data group identifier.

dataItemTypeId string

The data item type identifier.

dataItems IEnumerable<DataItem>

The data items.

Returns

int

WritePackageInfo(PackageInfo)

Writes the package information.

public void WritePackageInfo(PackageInfo packageInfo)

Parameters

packageInfo PackageInfo

The package information.