Get-FilesDownloadInfo
Download File.
Syntax
Path (Default)
InputObject
Description
Download File.
The command accepts files from the pipeline as -InputObject, and uses each one's Path and the connection that fetched it.
When given -InputObject, the command updates that object with the values Files.com returns and writes it.
Examples
Example 1: Download File
Writes the file as Files.com returns it.
Example 2: Act on files from the pipeline
Takes the file from the pipeline and uses its Path and connection.
Parameters
-Path
Path to operate on.
- Type:
System.String - Parameter sets:
Path(required, position 0)
-Action
Can be blank, redirect or stat. If set to stat, we will return file information but without a download URL, and without logging a download. If set to redirect we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
- Type:
System.String - Parameter sets:
Path,InputObject
-PreviewSize
Request a preview size. Can be small (default), large, xlarge, or pdf.
- Type:
System.String - Parameter sets:
Path,InputObject
-WithPreviews
Include file preview information?
- Type:
System.Boolean - Parameter sets:
Path,InputObject
-WithPriorityColor
Include file priority color information?
- Type:
System.Boolean - Parameter sets:
Path,InputObject
-WithDirectConnectionInfo
Include optional direct connection information for a direct Agent transfer attempt?
- Type:
System.Boolean - Parameter sets:
Path,InputObject
-InputObject
The file to act on, such as one written by another command of the module, from the pipeline. The command uses its Path and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.RemoteFile - Parameter sets:
InputObject(required)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
FilesCom.PowerShell.Models.RemoteFile: a file from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.RemoteFile: the remote file as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.