en-US/PSGist-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <!-- Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!-- Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!-- Module: PSGist Version: 1.2.1 --> <!-- All Commands--> <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--> <command:details> <command:name>Add-GistFile</command:name> <maml:description> <maml:para>Add a file to a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Add</command:verb> <command:noun>GistFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Add a file to an existing Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Add-GistFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to add a file to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to add to the Gist Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-GistFile</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to add a file to.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>The name of the file to be added to the Gist.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.DisplayName.TrimEnd('*')</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to add a file to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to add to the Gist Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!--Dynamic--> <maml:name>FileName</maml:name> <maml:description> <maml:para>The name of the file to be added to the Gist.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.DisplayName.TrimEnd('*')</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!-- Notes--> <maml:title>Dynamic Parameter</maml:title> <maml:alert> <maml:para>The IseScriptPane and FileName parameters are only avaiable from within the PowerShell ISE.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-GistFile -Id fbaba8119507ce58739ca356349cedb1 -Path .\HelloWorld.ps1 Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will add a new file to the Gist Object, named 'HelloWorld.ps1' with the contents of the file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-GistFile -Id fbaba8119507ce58739ca356349cedb1 -IseScriptPane Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will use the content from within the active ISE Script Pane as a new file for the Gist Object.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Edit a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#edit-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Copy-Gist</command:name> <maml:description> <maml:para>Copy (Fork) a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Copy (Fork) a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Copy-Gist</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to copy (fork).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to copy (fork).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!-- Notes--> <maml:title>Copying (Forking) Gists</maml:title> <maml:alert> <maml:para>The currently authenticated user context cannot copy (fork) their own Gist Object(s).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Copy-Gist -Id abcde12345 Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>Create a new Gist Object under the currently authenticated user context, using the lastest revision from another users Gist Object.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Fork a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#fork-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Get-Gist</command:name> <maml:description> <maml:para>Get a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-Gist</maml:name> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Gist</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Returns the Gist Objects of a specified user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Gist</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Returns a specific Gist Object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Gist</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Returns either Starred or Public Gist Objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Owner</maml:name> <maml:description> <maml:para>Returns the Gist Objects of a specified user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Returns a specific Gist Object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Target</maml:name> <maml:description> <maml:para>Returns either Starred or Public Gist Objects.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!-- Notes--> <maml:title>Privacy</maml:title> <maml:alert> <maml:para>Only Starred and Public Gist Objects of the currently authenticated user context can be returned when using the Target parameter.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-Gist -Owner dotps1 | Select-Object -First 1 Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>Returns all the Gist Objects owned by dotps1. (Selects the first one for example output simplicitiy.)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-Gist -Target Starred | Select-Object -First 1 Owner : dotps1 Description : Find users in a domain that have the protected attribute that should not, remove that attribute and re enable inheritance. Id : a5b60bdf7955e029a500 CreatedAt : 2/3/2016 3:20:37 PM UpdatedAt : 2/4/2016 11:59:19 AM Public : True HtmlUrl : https://gist.github.com/a5b60bdf7955e029a500</dev:code> <dev:remarks> <maml:para>Returns a list of all the current authenticated users context starred Gist Objects. (Selects the first one for example output simplicitiy.)</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Gists</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Get-GistCommit</command:name> <maml:description> <maml:para>Get GistCommit Objects of a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>GistCommit</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get-GistCommit Objects of a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-GistCommit</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to get commits from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to get commits from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>GistHistory</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-GistCommit -id fbaba8119507ce58739ca356349cedb1 User : dotps1 Version : 7027070018888418de9d05e867ed4fea249c974d CommittedAt : 4/18/2016 3:12:16 PM Additions : 21 Deletions : 0</dev:code> <dev:remarks> <maml:para>Gets the list of Commits made to a Gist Object.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>List Gist Commits</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#list-gist-commits</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Get-GistFork</command:name> <maml:description> <maml:para>Get Fork Objects of a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>GistFork</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get Fork Objects of a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-GistFork</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to return Fork Objects from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to return Fork Objects from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>GistFork</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-GistFork -Id c2d51c498f99dae2bb73 User : Tiberriver256 Id : e3d1cb9ce70d8450776bc00e735b369a CreatedAt : 4/19/2016 9:33:07 AM UpdatedAt : 4/19/2016 9:33:08 AM Url : https://api.github.com/gists/e3d1cb9ce70d8450776bc00e735b369a</dev:code> <dev:remarks> <maml:para>Gets the Forked Gist from supplied Gist ID.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>List Gist Forks</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#list-gist-forks</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Get-GistVersion</command:name> <maml:description> <maml:para>Get a Version of a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>GistVersion</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get a Version of a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-GistVersion</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>Id</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-GistVersion -Id fbaba8119507ce58739ca356349cedb1 -Version 7027070018888418de9d05e867ed4fea249c974d Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>Returns a specific version of gist. The Version value is returned from Get-GistCommit.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-Gist | Select-Object -First 1 | Get-GistCommit | Select-Object -Last 1 | Get-GistVersion Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>Gets the first commit of a Gist Object.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <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--> <command:details> <command:name>New-Gist</command:name> <maml:description> <maml:para>New Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>New Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-Gist</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to add to the Gist Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description value of the Gist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Public</maml:name> <maml:description> <maml:para>Specifies if the Gist should be publicly visalbe.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-Gist</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description value of the Gist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Public</maml:name> <maml:description> <maml:para>Specifies if the Gist should be publicly visalbe.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <!--Dynamic--> <maml:name>FileName</maml:name> <maml:description> <maml:para>The name of the file to be added to the Gist.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.DisplayName.TrimEnd('*')</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description value of the Gist.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Public</maml:name> <maml:description> <maml:para>Specifies if the Gist should be publicly visalbe.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to add to the Gist Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!--Dynamic--> <maml:name>FileName</maml:name> <maml:description> <maml:para>The name of the file to be added to the Gist.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.DisplayName.TrimEnd('*')</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Dynamic Parameter</maml:title> <!-- Notes--> <maml:alert> <maml:para>The IseScriptPane and FileName parameters are only avaiable from within the PowerShell ISE.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Add-GistFile -Id fbaba8119507ce58739ca356349cedb1 -Path .\HelloWorld.ps1 -Public Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will create a new Gist using the file 'HelloWorld.ps1'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-Gist -IseScriptPane -Public Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will create a new Gist using the currently active script tab from the PowerShell_Ise. The file will be named the tab title.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <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--> <command:details> <command:name>New-GistOAuthToken</command:name> <maml:description> <maml:para>New GitHub OAuth Token.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>GistOAuthToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>New GitHub OAuth Token using the supplied credentials giving API access to Gist Objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-GistOAuthToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Username and Password to authenticate to GitHub.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:defaultValue>Get-Credential</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>TokenDescription</maml:name> <maml:description> <maml:para>A description of the token being created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>PSGist PowerShell Module ($env:ComputerName)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Username and Password to authenticate to GitHub.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>Get-Credential</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>TokenDescription</maml:name> <maml:description> <maml:para>A description of the token being created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>PSGist PowerShell Module ($env:ComputerName)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Environment Variable</maml:title> <!-- Notes--> <maml:title>Permissions</maml:title> <maml:alert> <maml:para>This function is called at anytime the Invoke-GistApi (Private function) is called and the $env:GIST_OAUTH_TOKEN is $null.</maml:para> </maml:alert> <maml:alert> <maml:para>The token generated only gives rights to use and modify Gist objects, it cannot be used to manipulate GitHub Repositories.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>New-GistOAuthToken OAuth Token Value: 00000000000000000000000000000000</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-Credential | New-GistOAuthToken -Descrition 'My Gist OAuth Token' OAuth Token Value: 00000000000000000000000000000000</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>GitHub OAuth</maml:linkText> <maml:uri>https://developer.github.com/v3/oauth/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Remove-Gist</command:name> <maml:description> <maml:para>Remove Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-Gist</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.void(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Specifies a return value type for a method that does not return a value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Warning</maml:title> <!-- Notes--> <maml:alert> <maml:para>This will completely remove the Gist including its commits, revisions, comments, and files. It will not remove Forks that other users have made from this Gist Object.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-Gist -Id fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-Gist -Id fbaba8119507ce58739ca356349cedb1 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Use the -Confirm Parameter to bypass warning prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Delete a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#delete-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Remove-GistFile</command:name> <maml:description> <maml:para>Remove Gist File from a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>GistFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Remove Gist File from a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-GistFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Gist Object containing the file to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>The FileName to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Gist Object containing the file to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>The FileName to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.void(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Specifies a return value type for a method that does not return a value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-GistFile -Id fbaba8119507ce58739ca356349cedb1 -FileName HelloWorld.ps1</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Remove-GistFile -Id fbaba8119507ce58739ca356349cedb1 -FileName HelloWorld.ps1 -Confirm:$false</dev:code> <dev:remarks> <maml:para>Use the -Confirm Parameter to bypass warning prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Edit a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#edit-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Rename-GistFile</command:name> <maml:description> <maml:para>Rename Gist File from a Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>GistFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Rename Gist File from a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Rename-GistFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist containing the file to be renamed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>OldName</maml:name> <maml:description> <maml:para>The Current Name of the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>NewName</maml:name> <maml:description> <maml:para>The Name to be appiled to the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist containing the file to be renamed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>OldName</maml:name> <maml:description> <maml:para>The Current Name of the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>NewName</maml:name> <maml:description> <maml:para>The Name to be appiled to the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Rename-GistFile -Id fbaba8119507ce58739ca356349cedb1 -OldName HelloWorld.ps1 -NewName HelloWorld1.ps1 Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Edit a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#edit-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Save-Gist</command:name> <maml:description> <maml:para>Save Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Save</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Save Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Save-Gist</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to save the Gist and its file(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue>$env:APPDATA\PSGist</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist to be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to save the Gist and its file(s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>$env:APPDATA\PSGist</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist to be saved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.io.fileinfo(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Provides properties and instance methods for the creation, copying, deletion, moving, and opening of files, and aids in the creation of FileStream objects. This class cannot be inherited.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Save-Gist -Id fbaba8119507ce58739ca356349cedb1 Directory: C:\Users\tmalkewitz\AppData\Roaming\PSGist\fbaba8119507ce58739ca356349cedb1 Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 4/19/2016 12:44 PM 337 PSGist.psm1 </dev:code> <dev:remarks> <maml:para>Save the Gist file to local computer.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Set-Gist</command:name> <maml:description> <maml:para>Set Gist Object.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>Gist</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Set Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-Gist</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description to be applied top the Gist Object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-Gist</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Star</maml:name> <maml:description> <maml:para>Marks a Gist Object as 'Starred'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the Gist Object to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description to be applied top the Gist Object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Star</maml:name> <maml:description> <maml:para>Marks a Gist Object as 'Starred'.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.void(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Specifies a return value type for a method that does not return a value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Limitations</maml:title> <!-- Notes--> <maml:alert> <maml:para>At this time a Gist Object cannot be both Starred/UnStarred and have the Description updated at the same time.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-Gist -Id fbaba8119507ce58739ca356349cedb1 -Star $true</dev:code> <dev:remarks> <maml:para>Marks the Gist Object as Starred by the currently authenticated user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-Gist -Id fbaba8119507ce58739ca356349cedb1 -Description 'Hello World Gist.'</dev:code> <dev:remarks> <maml:para>Sets the description of the Gist Object to 'Hello World Gist.'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <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--> <command:details> <command:name>Set-GistOAuthToken</command:name> <maml:description> <maml:para>Set Gist OAuth Token.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>GistOAuthToken</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Set Gist OAuth Token value for authenticating to the GitHub API to access Gist Objects.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-GistOAuthToken</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases=""> <maml:name>Token</maml:name> <maml:description> <maml:para>The Value to set $env:GIST_OAUTH_TOKEN.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases=""> <maml:name>Token</maml:name> <maml:description> <maml:para>The Value to set $env:GIST_OAUTH_TOKEN.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri>Represents text as a sequence of UTF-16 code units.</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Unlikely To Be Used</maml:title> <!-- Notes--> <maml:title>Empty Token Parameter</maml:title> <maml:alert> <maml:para>After you create a GitHub Personal Access Token, if the value is not recorded, the value cannot be retrevied.</maml:para> </maml:alert> <maml:alert> <maml:para>If the Token Parameter is not used, this cmdlet will simply call the New-GistOAuthToken cmdlet.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-GistOAuthToken -Token '00000000000000000000000000000000' OAuth Token Value: 00000000000000000000000000000000</dev:code> <dev:remarks> <maml:para>Sets the value of $env:GIST_OAUTH_TOKEN.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>GitHub OAuth</maml:linkText> <maml:uri>https://developer.github.com/v3/oauth/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <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--> <command:details> <command:name>Update-GistFile</command:name> <maml:description> <maml:para>Update Gist File in a Gist Object</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Update</command:verb> <command:noun>GistFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Update Gist File in a Gist Object using the currently authenticated user context.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Update-GistFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Gist Object to update a File from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to be updated in the Gist Object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-GistFile</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Gist Object to update a File from.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="false" globbing="false" position="named" aliases=""> <!--Dynamic--> <maml:name>FileName</maml:name> <maml:description> <maml:para>The FileName of the item to be updated.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.Editor.Text </dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the Gist Object to update a File from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file to be updated in the Gist Object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>FileName</maml:name> <maml:description> <maml:para>The FileName of the item to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>$psISE.CurrentPowerShellTab.Files.SelectedFile.Editor.Text </dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases=""> <!--Dynamic--> <maml:name>IseScriptPane</maml:name> <maml:description> <maml:para>Use the content of the currently active PowerShell_ISE Tab.</maml:para> </maml:description> <command:parameterValue required="false">Switch</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri>https://msdn.microsoft.com/en-us/library/system.string(v=vs.110).aspx</maml:uri> </dev:type> <maml:description> <maml:para>Represents text as a sequence of UTF-16 code units.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Gist</maml:name> <maml:uri>https://developer.github.com/v3/gists/</maml:uri> </dev:type> <maml:description> <maml:para>A .net representation for the JSON Object returned from the GitHub API.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-GistFile -Id fbaba8119507ce58739ca356349cedb1 -Path .\HelloWorld.ps1 Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will add a new file to the Gist Object, named 'HelloWorld.ps1' with the contents of the file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Update-GistFile -Id fbaba8119507ce58739ca356349cedb1 -IseScriptPane Owner : dotps1 Description : Demo Gist for PSGist PowerShell Module. Id : fbaba8119507ce58739ca356349cedb1 CreatedAt : 4/18/2016 3:12:16 PM UpdatedAt : 4/18/2016 3:12:16 PM Public : True HtmlUrl : https://gist.github.com/fbaba8119507ce58739ca356349cedb1</dev:code> <dev:remarks> <maml:para>This will use the content from within the active ISE Script Pane as a new file for the Gist Object.</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Edit a Gist</maml:linkText> <maml:uri>https://developer.github.com/v3/gists/#edit-a-gist</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Project Home</maml:linkText> <maml:uri>http://dotps1.github.io/PSGist</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> </helpItems> |