en-US/poshbox-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>addremove-boxcollectionsforfile</command:name> <command:verb>addremove</command:verb> <command:noun>boxcollectionsforfile</command:noun> <maml:description> <maml:para>The id associated with the file you want to add/remove from the collection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The id associated with the file you want to add/remove from the collection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>addremove-boxcollectionsforfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file you want to add/remove from the collection</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>The id associated with the collection you want to add/remove from the collection</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>The id associated with the collection you want to add/remove from the collection</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file you want to add/remove from the collection</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> addremove-boxcollectionsforfile -fileid "1234567" -collectionid "4567890"</dev:code> <dev:remarks> <maml:para>Add or remove the file associated with the id 1234567 to/from the collection associated with the id 4567890.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Link 1</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Managers/BoxCollectionsManager.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>addremove-boxcollectionsforfolder</command:name> <command:verb>addremove</command:verb> <command:noun>boxcollectionsforfolder</command:noun> <maml:description> <maml:para>{{Fill in the Synopsis}}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>addremove-boxcollectionsforfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>{{Fill folderid 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>{{Fill collectionid 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>{{Fill collectionid 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>{{Fill folderid 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Managers/BoxCollectionsManager.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>connect-box</command:name> <command:verb>connect</command:verb> <command:noun>box</command:noun> <maml:description> <maml:para>This command will authenticate to box in the current powershell session</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will authenticate to box in the current powershell session. You can optionally supply the id of a box user to authenticate to box as the user. When first run, the full path to the json file which should have been obtained when the box app was created in your box environment. You only need to do this once. Please see https://github.com/whiggs/PoshBox for more information on how to obtain this file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>connect-box</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user which powershell should authenticate to box as.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The path of the json file containing the box authentication information</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user which powershell should authenticate to box as.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The path of the json file containing the box authentication information</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This command must be run in the powershell session before running any of the other box commands. Also, as mentioned previously, if a user id is supplied to the command, powershell will authenticate to box as the user in question. This is how you will be able to get/manipulate the box environments (files, folders, etc) of other users. This command creates two global variables that are available to the powershell environment when run: $tokenreal and $adminclient. For those who would rather use the box REST API to administrate box instead, the $tokenreal variable is the admin access token that is needed when invoking REST API calls. The $adminclient variable is the "master" object. It is from this one variable that every single other command in this module is built. This object contains all of the methods that can be used to administrate a box environment.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>C:\PS> connect-box</dev:code> <dev:remarks> <maml:para>Authenticate to box</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>C:\PS> connect-box -path C:\path\to\json\boxauthentication.json</dev:code> <dev:remarks> <maml:para>Authenticate to box after registering the box authentication information in the json file</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>C:\PS> connect-box -id 1234567</dev:code> <dev:remarks> <maml:para>Authenticate to box as the user associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>PoshBox Repo</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box API reference</maml:linkText> <maml:uri>https://developer.box.com/reference</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>copy-boxfile</command:name> <command:verb>copy</command:verb> <command:noun>boxfile</command:noun> <maml:description> <maml:para>Used to create a copy of a file in another folder. The original version of the file will not be altered.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to create a copy of a file in another folder. The original version of the file will not be altered.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>copy-boxfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>This id associated with the box file that should be copied</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that the box file should be copied 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties of the returned box file object that should be displayed. For more information about this parameter, see "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties of the returned box file object that should be displayed. For more information about this parameter, see "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>This id associated with the box file that should be copied</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that the box file should be copied 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> copy-boxfile -fileid 123456789 -parentfolderid 987654321</dev:code> <dev:remarks> <maml:para>This command copies the box file associated with the id 123456789 to the box folder associated with the id 987654321</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box file object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFile.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>copy-boxfolder</command:name> <command:verb>copy</command:verb> <command:noun>boxfolder</command:noun> <maml:description> <maml:para>This command will copy a folder in a user's box environment to another directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will copy a folder in a user's box environment to another directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>copy-boxfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the folder that will be copied</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the directory of the folder which the folder will be copied 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the folder that will be copied</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the directory of the folder which the folder will be copied 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> copy-boxfolder -folderid 4521395 -parentfolderid 4512789 -fields "item_collection","size","path_collection","content_created_at","name","id","type"</dev:code> <dev:remarks> <maml:para>This command copies a box folder to another box folder in the same user environment. The resulting box folder object will only display the information specified.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> copy-boxfolder -folderid 4521395 -parentfolderid 4512789</dev:code> <dev:remarks> <maml:para>This command will copy the folder with the id associated with the folder object 4521395 to the folder with the folder associated with the id 4512789. When the process completes, only the default properties will be visible.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxcollaborationinfo</command:name> <command:verb>Get</command:verb> <command:noun>boxcollaborationinfo</command:noun> <maml:description> <maml:para>Used to get information about a single collaboration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to get information about a single collaboration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxcollaborationinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>collaborationid</maml:name> <maml:Description> <maml:para>Id of the collaboration 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>collaborationid</maml:name> <maml:Description> <maml:para>Id of the collaboration 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollaboration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxcollaborationinfo -collaborationid 1234567</dev:code> <dev:remarks> <maml:para>Return information for the collaboration object associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box collaboration object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollaboration.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxcollectionitems</command:name> <command:verb>Get</command:verb> <command:noun>boxcollectionitems</command:noun> <maml:description> <maml:para>Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder's items.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder's items.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxcollectionitems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopaginate</maml:name> <maml:Description> <maml:para>Indicates that the function should return all of the items that it finds</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>Id associated with the collection which should be searched</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-boxcollectionitems</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>Id associated with the collection which should be searched</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The number of items the command should return. By default, this value is 1000</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The offset at which to begin the response. An offset of value of 0 will start at the beginning of the folder-listing. Offset of 2 would start at the 2nd record, not the second page. Note: If there are hidden items in your previous response, your next offset should be = offset + limit, not the # of records you received back.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopaginate</maml:name> <maml:Description> <maml:para>Indicates that the function should return all of the items that it finds</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>collectionid</maml:name> <maml:Description> <maml:para>Id associated with the collection which should be searched</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The number of items the command should return. By default, this value is 1000</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The offset at which to begin the response. An offset of value of 0 will start at the beginning of the folder-listing. Offset of 2 would start at the 2nd record, not the second page. Note: If there are hidden items in your previous response, your next offset should be = offset + limit, not the # of records you received back.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollectionitem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxcollectionitems -collectionid "16789034" -autopaginate</dev:code> <dev:remarks> <maml:para>This command obtains a list of all of the box items that are contained within the collection associated with the id 16789034 Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder's items.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-boxcollectionitems -collectionid "16789034" -limit 20 -offset 202</dev:code> <dev:remarks> <maml:para>This command obtains a list of at most 20 box items and starting on the box file at offset 202 that are contained within the collection associated with the id 16789034</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BoxCollectionitem Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollectionItem.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxcollections</command:name> <command:verb>get</command:verb> <command:noun>boxcollections</command:noun> <maml:description> <maml:para>Retrieves the collections for the given user. Currently, only the favorites collection is supported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the collections for the given user. Currently, only the favorites collection is supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxcollections</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxcollections</dev:code> <dev:remarks> <maml:para>Retrieves the collections for the given user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BoxCollection object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollection.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxcommentinfo</command:name> <command:verb>Get</command:verb> <command:noun>boxcommentinfo</command:noun> <maml:description> <maml:para>This command is used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command is used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxcommentinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment whose information should be returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment whose information should be returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxComment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxcommentinfo -commentid 123456789</dev:code> <dev:remarks> <maml:para>This command retrieves information about the comment associated with the id 123456789</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>BoxComment Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxComment.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxemailalias</command:name> <command:verb>Get</command:verb> <command:noun>boxemailalias</command:noun> <maml:description> <maml:para>This command will retrieve all of the box email aliases associated with a particular user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will retrieve all of the box email aliases associated with a particular user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxemailalias</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id of the user whose box email aliases should be displayed</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id of the user whose box email aliases should be displayed</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxEmailAlias</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxemailalias -userid 1234567</dev:code> <dev:remarks> <maml:para>Retrieve box email alias information for user with id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Boxemailalias object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxEmailAlias.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxenterpriseevents</command:name> <command:verb>get</command:verb> <command:noun>boxenterpriseevents</command:noun> <maml:description> <maml:para>Retrieve a chunk of Enterprise Events.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a chunk of Enterprise Events.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxenterpriseevents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Limits the number of events returned (defaults to 500).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The starting position for fetching the events. This is used in combination with the limit to determine which events to return to the caller. Use the results from the next_stream_position of your last call to get the next set of events.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>eventtypes</maml:name> <maml:Description> <maml:para>Events to filter by. The best way to see valid entries for this parameter is to run this command without any parameters and look at the event types that are returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>createdbefore</maml:name> <maml:Description> <maml:para>An upper bound on the timestamp of the events returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>createdafter</maml:name> <maml:Description> <maml:para>A lower bound on the timestamp of the events returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>createdafter</maml:name> <maml:Description> <maml:para>A lower bound on the timestamp of the events returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>createdbefore</maml:name> <maml:Description> <maml:para>An upper bound on the timestamp of the events returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>eventtypes</maml:name> <maml:Description> <maml:para>Events to filter by. The best way to see valid entries for this parameter is to run this command without any parameters and look at the event types that are returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Limits the number of events returned (defaults to 500).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The starting position for fetching the events. This is used in combination with the limit to determine which events to return to the caller. Use the results from the next_stream_position of your last call to get the next set of events.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxEnterpriseEvent</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxenterpriseevents</dev:code> <dev:remarks> <maml:para>Retrieve a list of 500 of the most recent box events.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Enterprise Event Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxEnterpriseEvent.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfilecomment</command:name> <command:verb>get</command:verb> <command:noun>boxfilecomment</command:noun> <maml:description> <maml:para>Retrieves the comments on a particular file, if any exist.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the comments on a particular file, if any exist. The function will only be able to see the comments of files that are accessable to the user that was specified when connect-box was run.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfilecomment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The Id of the item that the comments should be retrieved for.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The Id of the item that the comments should be retrieved for.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxComment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfilecomment -fileid 1234567</dev:code> <dev:remarks> <maml:para>Retrieves all comments for the file associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Comment Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxComment.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfileinfo</command:name> <command:verb>get</command:verb> <command:noun>boxfileinfo</command:noun> <maml:description> <maml:para>Retrieves information about a box file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves information about a box file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfileinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id associated with the file whose information should be returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id associated with the file whose information should be returned.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfileinfo -fileid 1234567</dev:code> <dev:remarks> <maml:para>Retrieves the infomation of the box file associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box File Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFile.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfileversions</command:name> <command:verb>get</command:verb> <command:noun>boxfileversions</command:noun> <maml:description> <maml:para>If there are previous versions of this file, this method can be used to retrieve metadata about the older versions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If there are previous versions of this file, this method can be used to retrieve metadata about the older versions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfileversions</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file whose versions should be returned</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file whose versions should be returned</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFileVersion</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfileversions -fileid 1234567</dev:code> <dev:remarks> <maml:para>Return the previous versions of the file associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box File Version Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFileVersion.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfoldercollaborations</command:name> <command:verb>get</command:verb> <command:noun>boxfoldercollaborations</command:noun> <maml:description> <maml:para>Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfoldercollaborations</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>Id of the folder whose collaborations should be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullOrEmptyAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullOrEmptyAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>Id of the folder whose collaborations should be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ValidateNotNullOrEmptyAttribute</command:parameterValue> <dev:type> <maml:name>ValidateNotNullOrEmptyAttribute</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollaboration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfoldercollaborations -foldid 1234567</dev:code> <dev:remarks> <maml:para>Retrieves the collaborations for the folder assocaited with the id 1234567.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Collaboration Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollaboration.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfolderinfo</command:name> <command:verb>get</command:verb> <command:noun>boxfolderinfo</command:noun> <maml:description> <maml:para>Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. To retrieve information about the root folder of a Box account use the id “0″.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. To retrieve information about the root folder of a Box account use the id “0″.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfolderinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder whose information should be returned.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder whose information should be returned.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfolderinfo -folderid 1234567</dev:code> <dev:remarks> <maml:para>Retrieves the full metadata for the box folder associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxfolderitems</command:name> <command:verb>get</command:verb> <command:noun>boxfolderitems</command:noun> <maml:description> <maml:para>This command returns a list of files and folders present in the indicated box folder in a box user's account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command returns a list of files and folders present in the indicated box folder in a box user's account. This command does not contain a parameter to define the user whose box files and folders should be returned. Therefore, in order to specify the user whose box files and folders need to be returned. you need to run the "connect-box" command with the id parameter set to the particular user's box id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxfolderitems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopage</maml:name> <maml:Description> <maml:para>indicates if the command should return all items.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the folder whose items should be returned. The default is "0", which indicates that the box user's root folder will be returned. This command is not recursive.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>get-boxfolderitems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the folder whose items should be returned. The default is "0", which indicates that the box user's root folder will be returned. This command is not recursive.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Indicates the number of items that the command should return. Will return 1000 items by default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>the position in the dataset of the items returned by the command. Defaults to 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopage</maml:name> <maml:Description> <maml:para>indicates if the command should return all items.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The properties that should be returned by the command. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the folder whose items should be returned. The default is "0", which indicates that the box user's root folder will be returned. This command is not recursive.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Indicates the number of items that the command should return. Will return 1000 items by default.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>the position in the dataset of the items returned by the command. Defaults to 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxfolderitems -autopage</dev:code> <dev:remarks> <maml:para>This command returns a list of all files and folders in the root of a user's box account folder.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> get-boxfolderitems -folderid 567895434 -offset 55 -limit 300</dev:code> <dev:remarks> <maml:para>This command returns a list of files and folders in the folder with the id 567895434 of a user's box account folder. The list of items will start at offset 55 and will be limited to 300 returned items max.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Item Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxItem.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxtrashedfolderitems</command:name> <command:verb>Get</command:verb> <command:noun>boxtrashedfolderitems</command:noun> <maml:description> <maml:para>Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in using the fields parameter. Paginated results can be retrieved using the limit and offset parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves the files and/or folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those specific attributes back; otherwise, the mini format is returned for each item by default. Multiple attributes can be passed in using the fields parameter. Paginated results can be retrieved using the limit and offset parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxtrashedfolderitems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopage</maml:name> <maml:Description> <maml:para>Whether or not to auto-paginate to fetch all items</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-boxtrashedfolderitems</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The maximum number of items to return</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The item at which to begin the response</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopage</maml:name> <maml:Description> <maml:para>Whether or not to auto-paginate to fetch all items</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The maximum number of items to return</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The item at which to begin the response</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxItem</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxtrashedfolderitems -autopage</dev:code> <dev:remarks> <maml:para>Retrieve all of the trashed box items in the current users box environment.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Item Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxItem.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxuserevents</command:name> <command:verb>get</command:verb> <command:noun>boxuserevents</command:noun> <maml:description> <maml:para>Use this to get events for a given user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this to get events for a given user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxuserevents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Limits the number of events returned (defaults to 500)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>usereventtype</maml:name> <maml:Description> <maml:para>Restricts the types of events returned: all returns all events; changes returns events that may cause file tree changes such as file updates or collaborations; sync returns events that may cause file tree changes only for synced folders</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">all</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">changes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sync</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>streamposition</maml:name> <maml:Description> <maml:para>The location in the event stream from which you want to start receiving events. You can specify the special value 'now' to get 0 events and the latest stream_position value. Defaults to 'now'.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>dedupeEvents</maml:name> <maml:Description> <maml:para>Whether or not to automatically de-duplicate events as they are received.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>dedupeEvents</maml:name> <maml:Description> <maml:para>Whether or not to automatically de-duplicate events as they are received.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>Limits the number of events returned (defaults to 500)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>streamposition</maml:name> <maml:Description> <maml:para>The location in the event stream from which you want to start receiving events. You can specify the special value 'now' to get 0 events and the latest stream_position value. Defaults to 'now'.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>usereventtype</maml:name> <maml:Description> <maml:para>Restricts the types of events returned: all returns all events; changes returns events that may cause file tree changes such as file updates or collaborations; sync returns events that may cause file tree changes only for synced folders</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxEventCollection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxuserinfo</command:name> <command:verb>Get</command:verb> <command:noun>boxuserinfo</command:noun> <maml:description> <maml:para>Retrieves information about a user in the enterprise.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves information about a user in the enterprise.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxuserinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id associated with the user whose information should be returned</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id associated with the user whose information should be returned</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxuserinfo -userid 1234567</dev:code> <dev:remarks> <maml:para>Retrieves information for the box user associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUser.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-boxuserinvite</command:name> <command:verb>Get</command:verb> <command:noun>boxuserinvite</command:noun> <maml:description> <maml:para>Returns information about an existing user invitation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns information about an existing user invitation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-boxuserinvite</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>inviteid</maml:name> <maml:Description> <maml:para>The ID associated with the user invitiation whose information should be returned</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>inviteid</maml:name> <maml:Description> <maml:para>The ID associated with the user invitiation whose information should be returned</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUserInvite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-boxuserinvite -inviteid 1234567</dev:code> <dev:remarks> <maml:para>Return information for the user invitation associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box user invite object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUserInvite.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-boxusers</command:name> <command:verb>get</command:verb> <command:noun>boxusers</command:noun> <maml:description> <maml:para>Get information about users in an enterprise.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get information about users in an enterprise.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-boxusers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:Description> <maml:para>Filter the results to only users starting with this value in either the name or the login.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopaginate</maml:name> <maml:Description> <maml:para>Whether or not to auto-paginate to fetch all users</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>externalappuserid</maml:name> <maml:Description> <maml:para>The external app user id</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The fields to populate for each returned user. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>usertype</maml:name> <maml:Description> <maml:para>The type of user to search for. Valid values are all, external or managed. If nothing is provided, the default behavior will be managed only</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>get-boxusers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:Description> <maml:para>Filter the results to only users starting with this value in either the name or the login.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>externalappuserid</maml:name> <maml:Description> <maml:para>The external app user id</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The fields to populate for each returned user. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The number of records to return. Max is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The record at which to start. Default is 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>usertype</maml:name> <maml:Description> <maml:para>The type of user to search for. Valid values are all, external or managed. If nothing is provided, the default behavior will be managed only</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:Description> <maml:para>Filter the results to only users starting with this value in either the name or the login.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>autopaginate</maml:name> <maml:Description> <maml:para>Whether or not to auto-paginate to fetch all users</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>externalappuserid</maml:name> <maml:Description> <maml:para>The external app user id</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>The fields to populate for each returned user. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>limit</maml:name> <maml:Description> <maml:para>The number of records to return. Max is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>offset</maml:name> <maml:Description> <maml:para>The record at which to start. Default is 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>usertype</maml:name> <maml:Description> <maml:para>The type of user to search for. Valid values are all, external or managed. If nothing is provided, the default behavior will be managed only</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollection<BoxUser></maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-boxusers -autopaginate</dev:code> <dev:remarks> <maml:para>Return a list of all box users in the enterprise environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> get-boxusers -limit 20 -offset 40 -searchstring "bobby"</dev:code> <dev:remarks> <maml:para>Return a list of at most 20 box users that contain the string "bobby" starting at record 40.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box collection Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollection.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-pendingboxcollaboration</command:name> <command:verb>get</command:verb> <command:noun>pendingboxcollaboration</command:noun> <maml:description> <maml:para>Used to retrieve all pending collaboration invites for this user (with user being determined by access token or As-User header value).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to retrieve all pending collaboration invites for this user (with user being determined by access token or As-User header value).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-pendingboxcollaboration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollaboration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-pendingboxcollaboration</dev:code> <dev:remarks> <maml:para>Returns a list of pending box collaborations.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Collaboration Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollaboration.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-trashedboxfolder</command:name> <command:verb>get</command:verb> <command:noun>trashedboxfolder</command:noun> <maml:description> <maml:para>Retrieves a folder that has been moved to the trash.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a folder that has been moved to the trash.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-trashedboxfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>ID associated with the trashed box folder whose information should be retrieved.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>ID associated with the trashed box folder whose information should be retrieved.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> get-trashedboxfolder -foldid 1234567</dev:code> <dev:remarks> <maml:para>Retrieve information for the trashed box folder associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Folder Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>invite-usertobox</command:name> <command:verb>invite</command:verb> <command:noun>usertobox</command:noun> <maml:description> <maml:para>Invites an existing user to join an Enterprise. The existing user cannot be part of another Enterprise and must already have a Box account. Once invited, the user will receive an email and prompt to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope for the enterprise, which can be enabled within your developer console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invites an existing user to join an Enterprise. The existing user cannot be part of another Enterprise and must already have a Box account. Once invited, the user will receive an email and prompt to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope for the enterprise, which can be enabled within your developer console.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>invite-usertobox</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>exuseremail</maml:name> <maml:Description> <maml:para>The email address of the external user that should be invited to the box enterprise subscription.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>exuseremail</maml:name> <maml:Description> <maml:para>The email address of the external user that should be invited to the box enterprise subscription.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUserInvite</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> invite-usertobox -exuseremail "testemail@gmail.com"</dev:code> <dev:remarks> <maml:para>Sends a box user invite email to testemail@gmail.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Invite Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUserInvite.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxcollaborator</command:name> <command:verb>new</command:verb> <command:noun>boxcollaborator</command:noun> <maml:description> <maml:para>Used to add a collaboration for a single user or a single group to a folder or file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to add a collaboration for a single user or a single group to a folder or file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxcollaborator</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>boxtype</maml:name> <maml:Description> <maml:para>The type of box object for which the collaboration will be created. Valid values are "file" and "folder."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">file</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">discussion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">comment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">folder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">retention_policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">enterprise</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">user</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">web_link</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">file_version</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">metadata_template</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>itemid</maml:name> <maml:Description> <maml:para>The id associated with the box item for which a collaboration should be created.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>inviteduserid</maml:name> <maml:Description> <maml:para>The id associated with the user who should be invited to the collaboration.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>role</maml:name> <maml:Description> <maml:para>The level of access the collaborator will have to the box item. Values for this parameter include "Editor", "Viewer", "previewer", "Uploader", "PreviewerUploader", "ViewerUploader", and "CoOwner."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Editor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Viewer</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>status</maml:name> <maml:Description> <maml:para>The status of the collaboration request. Valid values include "accepted" and "rejected."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">accepted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">rejected</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>expires</maml:name> <maml:Description> <maml:para>Allows you to specify if and when the collaboration will expire</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Determines if the user invited to the collaboration is notified of the invitation</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>boxtype</maml:name> <maml:Description> <maml:para>The type of box object for which the collaboration will be created. Valid values are "file" and "folder."</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>expires</maml:name> <maml:Description> <maml:para>Allows you to specify if and when the collaboration will expire</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>inviteduserid</maml:name> <maml:Description> <maml:para>The id associated with the user who should be invited to the collaboration.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>itemid</maml:name> <maml:Description> <maml:para>The id associated with the box item for which a collaboration should be created.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Determines if the user invited to the collaboration is notified of the invitation</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>role</maml:name> <maml:Description> <maml:para>The level of access the collaborator will have to the box item. Values for this parameter include "Editor", "Viewer", "previewer", "Uploader", "PreviewerUploader", "ViewerUploader", and "CoOwner."</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>status</maml:name> <maml:Description> <maml:para>The status of the collaboration request. Valid values include "accepted" and "rejected."</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxCollaboration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> new-boxcollaborator -boxtype "file" -inviteduserid 9876543 -itemid 1234567 -role "editor" -status "accepted" -notify</dev:code> <dev:remarks> <maml:para>Creates a collaboration for the box file associated with the id 1234567, invites the user associated with the id 9876543 to join the collaboration with editor permissions, and notifies the user of the collaboration membership.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> new-boxcollaborator -boxtype "folder" -inviteduserid 9876543 -itemid 1234567 -role "viewer" -status "accepted" -expires [datetime]"5/5/2025"</dev:code> <dev:remarks> <maml:para>Creates a collaboration for the box folder associated with the id 1234567, invites the user associated with the id 9876543 to join the collaboration with viewer permissions, configures the collaboration to expire on 5/5/2025 , and does not notify the user of the collaboration membership.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box collaboration object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxCollaboration.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxcomment</command:name> <command:verb>new</command:verb> <command:noun>boxcomment</command:noun> <maml:description> <maml:para>Used to add a comment by the user to a specific file, discussion, or comment (i.e. as a reply comment)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to add a comment by the user to a specific file, discussion, or comment (i.e. as a reply comment)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxcomment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>boxtype</maml:name> <maml:Description> <maml:para>The type of box object for which the collaboration will be created. Valid values for this parameter are "file", "discussion", and "comment."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">file</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">discussion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">comment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">folder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">retention_policy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">enterprise</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">user</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">group</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">web_link</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">file_version</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">metadata_template</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>entityid</maml:name> <maml:Description> <maml:para>The id associated with the box item which will be commented on.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>comment</maml:name> <maml:Description> <maml:para>The comment text.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>boxtype</maml:name> <maml:Description> <maml:para>The type of box object for which the collaboration will be created. Valid values for this parameter are "file", "discussion", and "comment."</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>comment</maml:name> <maml:Description> <maml:para>The comment text.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>entityid</maml:name> <maml:Description> <maml:para>The id associated with the box item which will be commented on.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxComment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> new-boxcomment -boxtype "file" -entityid 1234567 -comment "This is my awesome comment!"</dev:code> <dev:remarks> <maml:para>Comments "This is my awesome comment!" on the box file associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box comment object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxComment.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxemailalias</command:name> <command:verb>new</command:verb> <command:noun>boxemailalias</command:noun> <maml:description> <maml:para>This command will add a box email alias to a user's account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will add a box email alias to a user's account. A box email alias is identical to a regular email alias in that it is an alternative email that will receive box email updates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxemailalias</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id of the user whose account the email alias will be added</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>emailalias</maml:name> <maml:Description> <maml:para>The email address to assign to the user's account as an email alias</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>emailalias</maml:name> <maml:Description> <maml:para>The email address to assign to the user's account as an email alias</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id of the user whose account the email alias will be added</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.v2.models.boxemailalias</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> add-boxemailalias -id 1234567 -emailalias "hello@gmail.com"</dev:code> <dev:remarks> <maml:para>Add "hello@gmail.com" as an email alias to the user account associated with the id "1234567"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Email Alias Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxEmailAlias.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxfilesharelink</command:name> <command:verb>new</command:verb> <command:noun>boxfilesharelink</command:noun> <maml:description> <maml:para>Used to create a shared link for a particular box file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to create a shared link for a particular box file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxfilesharelink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id of the file which the share link will be created for.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>accesstype</maml:name> <maml:Description> <maml:para>The level of access required for this shared link. Valid values are "open", "company", and "collaborators."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">open</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">collaborators</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">company</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>password</maml:name> <maml:Description> <maml:para>The password to require before viewing this link</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>accesstype</maml:name> <maml:Description> <maml:para>The level of access required for this shared link. Valid values are "open", "company", and "collaborators."</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id of the file which the share link will be created for.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>password</maml:name> <maml:Description> <maml:para>The password to require before viewing this link</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxSharedLink</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> new-boxfilesharelink -fileid 1234567 -accesstype "collaborators"</dev:code> <dev:remarks> <maml:para>Creates a share link for the file associated with the id 1234567 and only allows collaborators to access the file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box share link object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxSharedLink.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxfolder</command:name> <command:verb>new</command:verb> <command:noun>boxfolder</command:noun> <maml:description> <maml:para>Used to create a new empty folder. The new folder will be created inside of the specified parent folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to create a new empty folder. The new folder will be created inside of the specified parent folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldername</maml:name> <maml:Description> <maml:para>The name of the new box folder</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentid</maml:name> <maml:Description> <maml:para>The id associated with the parent box folder that the new box folder should be created in. Use "0" if you want the new box folder to be created in the root folder of the box environment</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldername</maml:name> <maml:Description> <maml:para>The name of the new box folder</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentid</maml:name> <maml:Description> <maml:para>The id associated with the parent box folder that the new box folder should be created in. Use "0" if you want the new box folder to be created in the root folder of the box environment</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> new-boxfolder -foldername "mynewfolder" -parentid "0"</dev:code> <dev:remarks> <maml:para>This will create a new box folder named "mynewfolder" in the root folder of the current user's box environment.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxfoldersharelink</command:name> <command:verb>new</command:verb> <command:noun>boxfoldersharelink</command:noun> <maml:description> <maml:para>Used to create a shared link for a particular box folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to create a shared link for a particular box folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxfoldersharelink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id associated with the box folder for which the share link will be created.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>accesstype</maml:name> <maml:Description> <maml:para>The level of access required for this shared link. Valid values are "open", "company", and "collaborators."</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">open</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">collaborators</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">company</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>password</maml:name> <maml:Description> <maml:para>The password to require before viewing this link</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>accesstype</maml:name> <maml:Description> <maml:para>The level of access required for this shared link. Valid values are "open", "company", and "collaborators."</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id associated with the box folder for which the share link will be created.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>password</maml:name> <maml:Description> <maml:para>The password to require before viewing this link</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxSharedLink</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> new-boxfoldersharelink -accesstype "open" -foldid 1234567 -password "Password12"</dev:code> <dev:remarks> <maml:para>Creates a new share link for the box folder associated with the id 1234567. Everybody can access the folder, but it is also password protected using the password "Password12."</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Share Link Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxSharedLink.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-boxuser</command:name> <command:verb>new</command:verb> <command:noun>boxuser</command:noun> <maml:description> <maml:para>Used to provision a new user in an enterprise.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to provision a new user in an enterprise.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-boxuser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userdetails</maml:name> <maml:Description> <maml:para>A hashtable which will contain the property values that will define the user. The mandatory properties that must be defined are "name" and "login." Please view the documentation for the "Box User Request Object" that is linked below for other optional values that can be defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userdetails</maml:name> <maml:Description> <maml:para>A hashtable which will contain the property values that will define the user. The mandatory properties that must be defined are "name" and "login." Please view the documentation for the "Box User Request Object" that is linked below for other optional values that can be defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $hash = @{name = "Test User"; login = "test.user@makebelievedomain.com"} PS C:\> new-boxuser -userdetails $hash</dev:code> <dev:remarks> <maml:para>Creates a new box user named "test user" with the login email "test.user@makebelievedomain.com." These values were stored in a hash table, which was then fed to the function as a parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUser.cs</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Request Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/Request/BoxUserRequest.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxcollaboration</command:name> <command:verb>remove</command:verb> <command:noun>boxcollaboration</command:noun> <maml:description> <maml:para>Used to delete a single collaboration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to delete a single collaboration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxcollaboration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>collaborationid</maml:name> <maml:Description> <maml:para>The id associated with the collaboration object that should be deleted</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>collaborationid</maml:name> <maml:Description> <maml:para>The id associated with the collaboration object that should be deleted</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxcollaboration -collaborationid 1234567</dev:code> <dev:remarks> <maml:para>Deletes the collaboration associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxcomment</command:name> <command:verb>remove</command:verb> <command:noun>boxcomment</command:noun> <maml:description> <maml:para>Permanently deletes a comment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Permanently deletes a comment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxcomment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment that should be deleted.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment that should be deleted.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxcomment -commentid 1234567</dev:code> <dev:remarks> <maml:para>Deletes the comment associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxemailalias</command:name> <command:verb>remove</command:verb> <command:noun>boxemailalias</command:noun> <maml:description> <maml:para>Removes an email alias from a user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an email alias from a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxemailalias</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id associated with the user from whose account the email alias should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>aliasid</maml:name> <maml:Description> <maml:para>The id associated with the email alias that should 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>aliasid</maml:name> <maml:Description> <maml:para>The id associated with the email alias that should 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>userid</maml:name> <maml:Description> <maml:para>The id associated with the user from whose account the email alias should be deleted.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxemailalias -aliasid 1234567 -userid 7654321</dev:code> <dev:remarks> <maml:para>Removes the email alias associated with the id 1234567 from the box user associated with the id 7654321</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxfile</command:name> <command:verb>remove</command:verb> <command:noun>boxfile</command:noun> <maml:description> <maml:para>Discards a file to the trash.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Discards a file to the trash.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The ID associated with the box file that should be moved to the trash</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The ID associated with the box file that should be moved to the trash</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxfile -fileid 1234567</dev:code> <dev:remarks> <maml:para>Moves the box file associated with the ID 1234567 to the trash</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxfilesharelink</command:name> <command:verb>remove</command:verb> <command:noun>boxfilesharelink</command:noun> <maml:description> <maml:para>Used to delete the shared link for a particular box file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to delete the shared link for a particular box file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxfilesharelink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the box file whose shared link should be deleted</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the box file whose shared link should be deleted</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxfilesharelink -fileid 1234567</dev:code> <dev:remarks> <maml:para>Deletes the share link for the box file associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxfolder</command:name> <command:verb>remove</command:verb> <command:noun>boxfolder</command:noun> <maml:description> <maml:para>Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>recurse</maml:name> <maml:Description> <maml:para>Whether to delete this folder if it has items inside of it. If set, deletes the folder and all items within.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>recurse</maml:name> <maml:Description> <maml:para>Whether to delete this folder if it has items inside of it. If set, deletes the folder and all items within.</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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxfolder -folderid 1234567 -recurse</dev:code> <dev:remarks> <maml:para>Deletes the folder associated with the id 1234567 and all of the contents it contains</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxfoldersharedlink</command:name> <command:verb>remove</command:verb> <command:noun>boxfoldersharedlink</command:noun> <maml:description> <maml:para>Used to delete the shared link for the given folder id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to delete the shared link for the given folder id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxfoldersharedlink</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder whose shared link should be deleted.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder whose shared link should be deleted.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxfoldersharedlink -folderid 1234567</dev:code> <dev:remarks> <maml:para>Deletes the share link of the box folder associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxoldfileversion</command:name> <command:verb>remove</command:verb> <command:noun>boxoldfileversion</command:noun> <maml:description> <maml:para>Discards a specific file version to the trash.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Discards a specific file version to the trash.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxoldfileversion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file which contains the file version that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>versionid</maml:name> <maml:Description> <maml:para>The id associated with the version of the file that should be deleted</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>The id associated with the file which contains the file version that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>versionid</maml:name> <maml:Description> <maml:para>The id associated with the version of the file that should be deleted</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxoldfileversion -fileid 1234567 -versionid 7654321</dev:code> <dev:remarks> <maml:para>Deletes the file version associated with the id 7654321 from the box file 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxtrashfolder</command:name> <command:verb>remove</command:verb> <command:noun>boxtrashfolder</command:noun> <maml:description> <maml:para>Permanently deletes a folder that is in the trash. The folder will no longer exist in Box. This action cannot be undone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Permanently deletes a folder that is in the trash. The folder will no longer exist in Box. This action cannot be undone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxtrashfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id of the trashed box folder which should be permenantly deleted.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id of the trashed box folder which should be permenantly deleted.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxtrashfolder -foldid 1234567</dev:code> <dev:remarks> <maml:para>Permenantly deletes the trashed box folder associated with the id 1234567</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>remove-boxuser</command:name> <command:verb>remove</command:verb> <command:noun>boxuser</command:noun> <maml:description> <maml:para>Deletes a user in an enterprise account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes a user in an enterprise account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>remove-boxuser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>force</maml:name> <maml:Description> <maml:para>Whether or not the user should be deleted even if this user still own files.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Whether or not an email is sent to the owner of the deleted box user to notify them of the account deletion.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>force</maml:name> <maml:Description> <maml:para>Whether or not the user should be deleted even if this user still own files.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user that should be deleted.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Whether or not an email is sent to the owner of the deleted box user to notify them of the account deletion.</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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> remove-boxuser -id 1234567 -force</dev:code> <dev:remarks> <maml:para>Force deletes the box user associated with the id 1234567, even if the account owns box files.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>restore-trashedboxfolder</command:name> <command:verb>restore</command:verb> <command:noun>trashedboxfolder</command:noun> <maml:description> <maml:para>Restores an item that has been moved to the trash.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that parent folder, the new parent folder and/or new name will need to be included in the request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>restore-trashedboxfolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>trashedfolderid</maml:name> <maml:Description> <maml:para>The id associated with the trashed box folder that should be restored.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>restoretofolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder which the restored box folder should be restored 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>restoretofolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder which the restored box folder should be restored 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>trashedfolderid</maml:name> <maml:Description> <maml:para>The id associated with the trashed box folder that should be restored.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> restore-trashedboxfolder -trashedfolderid 1234567</dev:code> <dev:remarks> <maml:para>Restores the trashed box folder associated with the id 1234567 to the box folder it was originally located in prior to deletion.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>set-boxcomment</command:name> <command:verb>set</command:verb> <command:noun>boxcomment</command:noun> <maml:description> <maml:para>Used to update the message of the comment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to update the message of the comment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>set-boxcomment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment whose text should be changed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>comment</maml:name> <maml:Description> <maml:para>The text that should replace the text in the comment specified in the function.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>comment</maml:name> <maml:Description> <maml:para>The text that should replace the text in the comment specified in the function.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>commentid</maml:name> <maml:Description> <maml:para>The id associated with the comment whose text should be changed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxComment</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> set-boxcomment -commentid 1234567 -comment "This will be the text of comment 1234567"</dev:code> <dev:remarks> <maml:para>Replaces the text of the comment associated with the id 1234567 to "This will be the text of comment 1234567"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box Comment Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxComment.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>set-boxfolderinfo</command:name> <command:verb>set</command:verb> <command:noun>boxfolderinfo</command:noun> <maml:description> <maml:para>Used to update information about the folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to update information about the folder. To move a folder, update the ID of its parent. To enable an email address that can be used to upload files to this folder, update the folder_upload_email attribute.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>set-boxfolderinfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that should 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that the specified box folder should be moved 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>description</maml:name> <maml:Description> <maml:para>The description the box folder should have.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>name</maml:name> <maml:Description> <maml:para>The name that the specified box folder should be renamed 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderuploademail</maml:name> <maml:Description> <maml:para>Determines if an upload email is configured for the box folder. See notes for more information on upload email.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>description</maml:name> <maml:Description> <maml:para>The description the box folder should have.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>folderuploademail</maml:name> <maml:Description> <maml:para>Determines if an upload email is configured for the box folder. See notes for more information on upload email.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>foldid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that should 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>name</maml:name> <maml:Description> <maml:para>The name that the specified box folder should be renamed 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentfolderid</maml:name> <maml:Description> <maml:para>The id associated with the box folder that the specified box folder should be moved 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>When a upload email is configured for a box folder, an email address is generated which will allow users to upload files to the afformentioned folder by attaching the files to an email and sending it to the upload email address.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> set-boxfolderinfo -foldid 1234567 -description "This is the new description for the box folder" -name "newname" -folderuploademail</dev:code> <dev:remarks> <maml:para>Modifies the folder associated with the id 1234567 by changing the description to "This is the new description for the box folder", changing the box folder's name to "newname", and configuring an upload email address for the box folder.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>set-boxuser</command:name> <command:verb>set</command:verb> <command:noun>boxuser</command:noun> <maml:description> <maml:para>Used to edit the settings and information about a user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to edit the settings and information about a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>set-boxuser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>updateinfo</maml:name> <maml:Description> <maml:para>A hashtable which will contain the properties of the box user you want to modify and the new values for those properties. Must specify the box user's "id" property in the hashtable in order to identify which user should be modified. Please view the documentation for the "Box User Request Object" that is linked below for other optional values that can be defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>updateinfo</maml:name> <maml:Description> <maml:para>A hashtable which will contain the properties of the box user you want to modify and the new values for those properties. Must specify the box user's "id" property in the hashtable in order to identify which user should be modified. Please view the documentation for the "Box User Request Object" that is linked below for other optional values that can be defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $hash = @{id = "1234567"; name = "Bob NewName"; Phone = "5555555555"; Role = "coadmin"} PS C:\> set-boxuser -updateinfo $hash</dev:code> <dev:remarks> <maml:para>Changes the name, phone, and role properties of the box user associated with the id 1234567.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUser.cs</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Request Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/Request/BoxUserRequest.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>set-boxuserlogin</command:name> <command:verb>set</command:verb> <command:noun>boxuserlogin</command:noun> <maml:description> <maml:para>Used to convert one of the user’s confirmed email aliases into the user’s primary login.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to convert one of the user’s confirmed email aliases into the user’s primary login.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>set-boxuserlogin</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user whose login email address should be changed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>newlogin</maml:name> <maml:Description> <maml:para>The email alias that should be configured as the new primary login</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>The id associated with the user whose login email address should be changed.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>newlogin</maml:name> <maml:Description> <maml:para>The email alias that should be configured as the new primary login</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxUser</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> set-boxuserlogin -id 1234567 -newlogin "newloginemail@domain.com"</dev:code> <dev:remarks> <maml:para>Sets the login email for the user associated with the id 1234567 to "newloginemail@domain.com"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box User Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxUser.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>transfer-boxusercontent</command:name> <command:verb>transfer</command:verb> <command:noun>boxusercontent</command:noun> <maml:description> <maml:para>Moves all of the owned content from within one user’s folder into a new folder in another user’s account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Moves all of the owned content from within one user’s folder into a new folder in another user’s account. You can move folders across users as long as the you have administrative permissions and the ‘source’ user owns the folders. To move everything from the root folder, use “0” which always represents the root folder of a Box account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>transfer-boxusercontent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>Id associated with the user whose content will be transfered to another user's box account.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ownerid</maml:name> <maml:Description> <maml:para>The id associated with the user who should receive the content of the specified user's box account</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Determines if the destination user should receive email notification of the transfer.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>id</maml:name> <maml:Description> <maml:para>Id associated with the user whose content will be transfered to another user's box account.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>notify</maml:name> <maml:Description> <maml:para>Determines if the destination user should receive email notification of the transfer.</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ownerid</maml:name> <maml:Description> <maml:para>The id associated with the user who should receive the content of the specified user's box account</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> transfer-boxusercontent -id 1234567 -ownerid 7654321</dev:code> <dev:remarks> <maml:para>Transfers the content of the box account associated with the user with the id 1234567 to the box account of the user associated with the id 7654321, who is not notified of the transfer.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box folder object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFolder.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>upload-boxfile</command:name> <command:verb>upload</command:verb> <command:noun>boxfile</command:noun> <maml:description> <maml:para>Uploads a provided file to the target parent folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uploads a provided file to the target parent folder. File cannot already exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>upload-boxfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>filename</maml:name> <maml:Description> <maml:para>The name that should be associated with the file when it is uploaded to box.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentdirid</maml:name> <maml:Description> <maml:para>The id associated with the box folder in which the uploaded file should be stored.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The full path to the local file to upload.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>timespan</maml:name> <maml:Description> <maml:para>The timeout value of the upload process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>filename</maml:name> <maml:Description> <maml:para>The name that should be associated with the file when it is uploaded to box.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>parentdirid</maml:name> <maml:Description> <maml:para>The id associated with the box folder in which the uploaded file should be stored.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The full path to the local file to upload.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>timespan</maml:name> <maml:Description> <maml:para>The timeout value of the upload process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $time = New-Object System.TimeSpan -ArgumentList 0, 15, 0 PS C:\> upload-boxfile -filename "myupload.pdf" -parentdirid 1234567 -path "$env:USERPROFILE\Documents\importantfile.pdf" -timespan $time</dev:code> <dev:remarks> <maml:para>Uploads the file located at the path "$env:USERPROFILE\Documents\importantfile.pdf" to the box folder associated with the id 1234567 and renames the file "myupload.pdf".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box File Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFile.cs</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>upload-boxfilenewversion</command:name> <command:verb>upload</command:verb> <command:noun>boxfilenewversion</command:noun> <maml:description> <maml:para>Used to upload a new version of an existing file in a user’s account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used to upload a new version of an existing file in a user’s account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>upload-boxfilenewversion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>filename</maml:name> <maml:Description> <maml:para>Name of the box 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id associated with the box file which should be uploaded to box as a new box file version.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The full path to the file that should be uploaded as a new file version to box.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>timespan</maml:name> <maml:Description> <maml:para>The timeout for the upload process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>fields</maml:name> <maml:Description> <maml:para>Attribute(s) to include in the response. To retrieve more information about valid field properties, please see the help content for "about_poshbox"</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>fileid</maml:name> <maml:Description> <maml:para>Id associated with the box file which should be uploaded to box as a new box file version.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>filename</maml:name> <maml:Description> <maml:para>Name of the box 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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>path</maml:name> <maml:Description> <maml:para>The full path to the file that should be uploaded as a new file version to box.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>timespan</maml:name> <maml:Description> <maml:para>The timeout for the upload process.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Box.V2.Models.BoxFile</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $time = New-Object System.TimeSpan -ArgumentList 0, 15, 0 PS C:\> upload-boxfilenewversion -filename "myupload.pdf" -fileid 1234567 -timespan $time</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/whiggs/PoshBox</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Box File Object</maml:linkText> <maml:uri>https://github.com/box/box-windows-sdk-v2/blob/master/Box.V2/Models/BoxFile.cs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |