SteamStorefront.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-SteamApp --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SteamApp</command:name> <command:verb>Get</command:verb> <command:noun>SteamApp</command:noun> <maml:description> <maml:para>Retrieves information about an application in the steam store.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SteamApp</maml:name> <!-- Parameter: AppId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,packageid"> <maml:name>AppId</maml:name> <maml:description> <maml:para>Steam Package ID</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AppId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,packageid"> <maml:name>AppId</maml:name> <maml:description> <maml:para>Steam Package ID</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,packageid"> <maml:name>id</maml:name> <maml:description> <maml:para>Steam Package ID</maml:para> <maml:para>This is an alias of the AppId parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,packageid"> <maml:name>packageid</maml:name> <maml:description> <maml:para>Steam Package ID</maml:para> <maml:para>This is an alias of the AppId parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>country</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>cc</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Steam Package ID</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: SteamApp --> <command:returnValue> <dev:type> <maml:name>SteamStorefrontAPI.Classes.SteamApp</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Example 1: Get an application by id</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>Get-SteamApp -AppId 323170</dev:code> <dev:remarks> <maml:para>This command gets steamapp with id 323170.</maml:para> <maml:para></maml:para> <maml:para>Example 2: Get an application by country and language</maml:para> <maml:para></maml:para> <maml:para>PS C:\>Get-SteamApp -AppId 323170 -Region "JP" -Language "german"</maml:para> <maml: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.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SteamFeaturedApp --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SteamFeaturedApp</command:name> <command:verb>Get</command:verb> <command:noun>SteamFeaturedApp</command:noun> <maml:description> <maml:para>Retrieves a list of all apps on the steam store.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-SteamFeaturedApp cmdlet gets a list of all featured categories on steam front page, grouped by platforms.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SteamFeaturedApp</maml:name> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>country</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>cc</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FeaturedApps --> <command:returnValue> <dev:type> <maml:name>SteamStorefrontAPI.Classes.FeaturedApps</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Example 1: Get a list of all featured apps by region.</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>Get-SteamFeaturedApp -Region "US"</dev:code> <dev:remarks> <maml:para>This command gets a list of all featured apps for region US.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SteamFeaturedCategory --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SteamFeaturedCategory</command:name> <command:verb>Get</command:verb> <command:noun>SteamFeaturedCategory</command:noun> <maml:description> <maml:para>Retrieves a list of all featured app categories and applications in these categories.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SteamFeaturedCategory</maml:name> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>country</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="country,cc"> <maml:name>cc</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FeaturedCategory --> <command:returnValue> <dev:type> <maml:name>SteamStorefrontAPI.Classes.FeaturedCategory</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Example 1: Get a list of all featured app categories by region</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>Get-SteamFeaturedCategory -Region "US"</dev:code> <dev:remarks> <maml:para>This command gets a list of all featured app categories for region US.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-SteamPackage --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-SteamPackage</command:name> <command:verb>Get</command:verb> <command:noun>SteamPackage</command:noun> <maml:description> <maml:para>Retrieves information about a package in the steam store.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-SteamPackage</maml:name> <!-- Parameter: PackageId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,appid"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>Steam App ID</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: PackageId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,appid"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>Steam App ID</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,appid"> <maml:name>id</maml:name> <maml:description> <maml:para>Steam App ID</maml:para> <maml:para>This is an alias of the PackageId parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="id,appid"> <maml:name>appid</maml:name> <maml:description> <maml:para>Steam App ID</maml:para> <maml:para>This is an alias of the PackageId parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Region --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>Region</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>country</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="country,cc"> <maml:name>cc</maml:name> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> <maml:para>This is an alias of the Region parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Language --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Language</maml:name> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Steam App ID</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Two letter country code to customise currency and date values.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Full name of the language in english used for string localization e.g. name, description.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PackageInfo --> <command:returnValue> <dev:type> <maml:name>SteamStorefrontAPI.Classes.PackageInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Example 1: Get an application by id</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\>Get-SteamPackage -PackageId 73194</dev:code> <dev:remarks> <maml:para>This command gets package with id 73194.</maml:para> <maml:para></maml:para> <maml:para>Example 2: Get an application by country and language</maml:para> <maml:para></maml:para> <maml:para>PS C:\>Get-SteamPackage -PackageId 73194 -Region "AT" -Language "spanish"</maml:para> <maml: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.</maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |