bin/Hsp.Ps.UPack.Core.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Hsp.Ps.UPack.Core</name>
    </assembly>
    <members>
        <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.Name">
            <summary>
            <param type="description">
            Specifies the name of the package.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.Group">
            <summary>
            <param type="description">
            Specifies the package group.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.Version">
            <summary>
            <param type="description">
            Specifies the version to retrieve. If this is not specified, the latest version is retrieved.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.FolderPath">
            <summary>
            <param type="description">
            If specified, extracts the contents of the package to this folder. The folder is created, if it does not exist.
            Note that the package will be stored in a subfolder with the same name as the package version inside this folder.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.Force">
            <summary>
            <param type="description">
            If specified, installs the package event if it has already been installed.
            </param>
            </summary>
        </member>
        <member name="M:Hsp.Ps.UPack.Core.InstallUPackPackage.ProcessRecord">
            <inheritdoc />
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.Name">
            <summary>
            <param type="description">
            Specifies the name of the package.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.Group">
            <summary>
            <param type="description">
            Specifies the package group.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.Version">
            <summary>
            <param type="description">
            Specifies the version to retrieve. If this is not specified, the latest version is retrieved.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.PackageFilePath">
            <summary>
            <param type="description">
            If specified, stores the package file to this path.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.ContentFolderPath">
            <summary>
            <param type="description">
            If specified, extracts the contents of the package to this folder. The folder is created, if it does not exist.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.GetUPackPackageData.Register">
            <summary>
            If this is specified, the package will also be registered in the local package registry.
            Note that this is only available when using "ContentFolderPath"
            </summary>
        </member>
        <member name="M:Hsp.Ps.UPack.Core.GetUPackPackageData.BeginProcessing">
            <inheritdoc />
        </member>
        <member name="M:Hsp.Ps.UPack.Core.GetUPackPackageData.ProcessRecord">
            <inheritdoc />
        </member>
        <member name="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.FeedUri">
            <summary>
            <param type="description">
            Specifies the feed API endpoint URL.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.Credential">
            <summary>
            <param type="description">
            Specifies the credentials to use when connecting to the feed. This is alternative to using <seealso cref="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.ApiKey"/>.
            </param>
            </summary>
        </member>
        <member name="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.ApiKey">
            <summary>
            <param type="description">
            Specifies the API key to use when connecting to the feed. This is alternative to using <seealso cref="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.Credential"/>.
            </param>
            </summary>
        </member>
    </members>
</doc>