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.NewUPackSession.Global"> <summary> <para type="description">If specified, stores the created session as global default session.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.NewUPackSession.SaveCredentials"> <summary> <para type="description">Specifies whether credentials should be stored in the windows credential store.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.NewUPackSession.InstallFolder"> <summary> <para type="description">Specifies a default installation folder for this session.</para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.NewUPackSession.ProcessRecord"> <inheritdoc /> </member> <member name="T:Hsp.Ps.UPack.Core.GetInstalledUpackPackage"> <summary> <para type="synopsis">Retrieves a list of all locally installed packages.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetInstalledUpackPackage.Name"> <summary> <para type="description"> Specifies the name of the package. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetInstalledUpackPackage.Group"> <summary> <para type="description"> Specifies the package group. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetInstalledUpackPackage.Version"> <summary> <para type="description"> Specifies the version to retrieve. If this is not specified, the latest version is retrieved. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetInstalledUpackPackage.Scope"> <summary> <para type="description"> Specifies the installation scope. </para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.GetInstalledUpackPackage.ProcessRecord"> <inheritdoc /> </member> <member name="P:Hsp.Ps.UPack.Core.RemoveUPackSession.Session"> <summary> <para type="description">The session to remove. If this is not specified, the currently active global session is removed instead.</para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.RemoveUPackSession.ProcessRecord"> <inheritdoc /> </member> <member name="M:Hsp.Ps.UPack.Core.TestCredentialsCmdlet.ProcessRecord"> <inheritdoc /> </member> <member name="P:Hsp.Ps.UPack.Core.UninstallUPackPackage.Name"> <summary> <param type="description"> Specifies the name of the package. </param> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.UninstallUPackPackage.Group"> <summary> <param type="description"> Specifies the package group. </param> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.UninstallUPackPackage.UninstallScriptName"> <summary> <para type="description"> If specified, this PowerShell script is executed before un-installation. The file must exist inside the package folder. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.UninstallUPackPackage.Scope"> <summary> <para type="description">Specifies the installation scope.</para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.UninstallUPackPackage.ProcessRecord"> <inheritdoc /> </member> <member name="T:Hsp.Ps.UPack.Core.InstallUPackPackage"> <summary> <para type="synopsis">Installs a package.</para> </summary> </member> <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> <para 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 of the form [name]/[version] inside this folder. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.InstallScriptName"> <summary> <para type="description"> If specified, this PowerShell script is executed after installation. The file must exist inside the package folder. </para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.InstallUPackPackage.Force"> <summary> <param type="description"> If specified, installs the package even if it has already been installed. </param> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.InstallUPackPackage.ProcessRecord"> <inheritdoc /> </member> <member name="T:Hsp.Ps.UPack.Core.InstallationScope"> <summary> Indicates the installation scope. </summary> </member> <member name="F:Hsp.Ps.UPack.Core.InstallationScope.User"> <summary> User repository </summary> </member> <member name="F:Hsp.Ps.UPack.Core.InstallationScope.Machine"> <summary> Machine repository. This requires administrative privileges. </summary> </member> <member name="T:Hsp.Ps.UPack.Core.FileAssociation"> <summary> Describes a windows explorer file association. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FileAssociation.Extension"> <summary> The extension of the association. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FileAssociation.ProgId"> <summary> A custom id that is used to identify the associated program. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FileAssociation.FileTypeDescription"> <summary> The description of the file association. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FileAssociation.ExecuteCommand"> <summary> The command to be executed for this association. </summary> </member> <member name="T:Hsp.Ps.UPack.Core.InstallTools"> <summary> Provides tools and helpers to perform installation related tasks. </summary> </member> <member name="M:Hsp.Ps.UPack.Core.InstallTools.RegisterFileAssociation(Hsp.Ps.UPack.Core.FileAssociation[])"> <summary> Registers one or more file association. </summary> <param name="associations">The associations to register.</param> </member> <member name="M:Hsp.Ps.UPack.Core.InstallTools.CreateMenuShortcut(Hsp.Ps.UPack.Core.MenuLink[])"> <summary> Creates one or more menu links in the windows start menu. </summary> <param name="links">The menu links to create.</param> </member> <member name="T:Hsp.Ps.UPack.Core.MenuLink"> <summary> Describes a windows start-menu shortcut. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.Title"> <summary> The title of the shortcut. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.LinkTarget"> <summary> The target that the shortcut points to. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.Icon"> <summary> An URL to the icon displayed for the shortcut. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.LinkGroup"> <summary> The name of the group (subfolder) where to place this shortcut. </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.Arguments"> <summary> Arguments for the <seealso cref="P:Hsp.Ps.UPack.Core.MenuLink.LinkTarget"/> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.WorkingDirectory"> <summary> An optional working directory for the <seealso cref="P:Hsp.Ps.UPack.Core.MenuLink.LinkTarget"/> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.MenuLink.HotKey"> <summary> An optional Hotkey </summary> </member> <member name="M:Hsp.Ps.UPack.Core.MenuLink.#ctor(System.String)"> <summary> Creates a new instance. </summary> <param name="linkGroup">The name of the subfolder.</param> </member> <member name="T:Hsp.Ps.UPack.Core.GetUPackPackageData"> <summary> <para type="synopsis">Retrieves the raw data stream of a package.</para> </summary> </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="M:Hsp.Ps.UPack.Core.GetUPackPackageData.BeginProcessing"> <inheritdoc /> </member> <member name="M:Hsp.Ps.UPack.Core.GetUPackPackageData.ProcessRecord"> <inheritdoc /> </member> <member name="T:Hsp.Ps.UPack.Core.GetUPackPackage"> <summary> <para type="synopsis">Retrieves a list of all packages on a feed.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetUPackPackage.Group"> <summary> <para type="description">Indicates the package group to look for.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetUPackPackage.Name"> <summary> <para type="description">Indicates the package name(s) to look for.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetUPackPackage.MinVersion"> <summary> <para type="description">If specified, indicates the minimum version of the package to look for.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetUPackPackage.AllVersions"> <summary> <para type="description">Specifies whether all available versions should be returned, as opposed to only the latest available version.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.GetUPackPackage.IncludeIcon"> <summary> <para type="description">Specifies whether package icons should be downloaded and included.</para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.GetUPackPackage.ProcessRecord"> <inheritdoc /> </member> <member name="T:Hsp.Ps.UPack.Core.GetUPackPackageMetadata"> <summary> <para type="synopsis">Retrieves the package metadata JSON of a package.</para> </summary> </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.Credentials"> <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.Credentials"/>. </param> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.Session"> <summary> <para type="description">If specified, this session is used.</para> </summary> </member> <member name="P:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.Scope"> <summary> <para type="description">Specifies the installation scope.</para> </summary> </member> <member name="M:Hsp.Ps.UPack.Core.FeedUPackCmdletBase.GetSession(System.Boolean)"> <summary> Creates a UPack session. </summary> <param name="withError">If true, a runtime error is thrown if no session was found or could be created.</param> <returns></returns> </member> <member name="M:Hsp.Ps.UPack.Core.UPackSession.MakeClient"> <summary> Creates a client instance for this session. </summary> <returns>An instance of the client.</returns> </member> </members> </doc> |