SteamStorefront.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>SteamStorefront</name> </assembly> <members> <member name="T:SteamStorefront.GetSteamPackageCmdlet"> <summary> <para type="synopsis">Retrieves information about a package in the steam store.</para> <para type="description">The Get-SteamPackage cmdlet gets information about a package in the steam store. The returned object contains all information about the package that's available on the steam storefront api.</para> <para type="example"></para> </summary> <example> <para>Example 1: Get an application by id</para> <para></para> <code>PS C:\>Get-SteamPackage -PackageId 73194</code> <para>This command gets package with id 73194.</para> <para></para> <para>Example 2: Get an application by country and language</para> <para></para> <code>PS C:\>Get-SteamPackage -PackageId 73194 -Region "AT" -Language "spanish"</code> <para>This command gets package with id 73194 with regional parameters like date format, price or currency for the austrian steam store, with strings localized to spanish.</para> <para></para> </example> </member> <member name="P:SteamStorefront.GetSteamPackageCmdlet.PackageId"> <summary> <para type="description">Steam App ID</para> </summary> </member> <member name="P:SteamStorefront.GetSteamPackageCmdlet.Region"> <summary> <para type="description">Two letter country code to customise currency and date values.</para> </summary> </member> <member name="P:SteamStorefront.GetSteamPackageCmdlet.Language"> <summary> <para type="description">Full name of the language in english used for string localization e.g. name, description.</para> </summary> </member> <member name="M:SteamStorefront.GetSteamPackageCmdlet.ProcessRecord"> <summary> <para type="description">ProcessRecord method</para> </summary> </member> <member name="T:SteamStorefront.GetSteamFeaturedCategoryCmdlet"> <summary> <para type="synopsis">Retrieves a list of all featured app categories and applications in these categories.</para> <para type="description">The Get-SteamFeaturedCategory cmdlet gets a list of all featured categories on steam front page, e.g. new releases, top sellers, spotlights or daily deals and lists all applications in each of the categories.</para> <para type="example"></para> </summary> <example> <para>Example 1: Get a list of all featured app categories by region</para> <para></para> <code>PS C:\>Get-SteamFeaturedCategory -Region "US"</code> <para>This command gets a list of all featured app categories for region US.</para> </example> </member> <member name="P:SteamStorefront.GetSteamFeaturedCategoryCmdlet.Region"> <summary> <para type="description">Two letter country code to customise currency and date values.</para> </summary> </member> <member name="P:SteamStorefront.GetSteamFeaturedCategoryCmdlet.Language"> <summary> <para type="description">Full name of the language in english used for string localization e.g. name, description.</para> </summary> </member> <member name="M:SteamStorefront.GetSteamFeaturedCategoryCmdlet.ProcessRecord"> <summary> <para type="description">ProcessRecord method</para> </summary> </member> <member name="T:SteamStorefront.GetSteamFeaturedAppCmdlet"> <summary> <para type="synopsis">Retrieves a list of all apps on the steam store.</para> <para type="description">The Get-SteamFeaturedApp cmdlet gets a list of all featured categories on steam front page, grouped by platforms.</para> <para type="example"></para> </summary> <example> <para>Example 1: Get a list of all featured apps by region.</para> <para></para> <code>PS C:\>Get-SteamFeaturedApp -Region "US"</code> <para>This command gets a list of all featured apps for region US.</para> </example> </member> <member name="P:SteamStorefront.GetSteamFeaturedAppCmdlet.Region"> <summary> <para type="description">Two letter country code to customise currency and date values.</para> </summary> </member> <member name="P:SteamStorefront.GetSteamFeaturedAppCmdlet.Language"> <summary> <para type="description">Full name of the language in english used for string localization e.g. name, description.</para> </summary> </member> <member name="M:SteamStorefront.GetSteamFeaturedAppCmdlet.ProcessRecord"> <summary> <para type="description">ProcessRecord method</para> </summary> </member> <member name="T:SteamStorefront.GetSteamAppCmdlet"> <summary> <para type="synopsis">Retrieves information about an application in the steam store.</para> <para type="description">The Get-SteamApp cmdlet gets information about an application in the steam store. The returned object contains all information about the application that's available on the steam storefront api.</para> <para type="example"></para> </summary> <example> <para>Example 1: Get an application by id</para> <para></para> <code>PS C:\>Get-SteamApp -AppId 323170</code> <para>This command gets steamapp with id 323170.</para> <para></para> <para>Example 2: Get an application by country and language</para> <para></para> <code>PS C:\>Get-SteamApp -AppId 323170 -Region "JP" -Language "german"</code> <para>This command gets steamapp with id 323170 with regional parameters like date format, price or currency for the japanese steam store, with strings localized to german.</para> <para></para> </example> </member> <member name="P:SteamStorefront.GetSteamAppCmdlet.AppId"> <summary> <para type="description">Steam Package ID</para> </summary> </member> <member name="P:SteamStorefront.GetSteamAppCmdlet.Region"> <summary> <para type="description">Two letter country code to customise currency and date values.</para> </summary> </member> <member name="P:SteamStorefront.GetSteamAppCmdlet.Language"> <summary> <para type="description">Full name of the language in english used for string localization e.g. name, description.</para> </summary> </member> <member name="M:SteamStorefront.GetSteamAppCmdlet.ProcessRecord"> <summary> <para type="description">ProcessRecord method</para> </summary> </member> </members> </doc> |