Set-FilesStyle
Update Style.
Syntax
Path (Default)
InputObject
Description
Update Style.
The command accepts styles 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.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
File parameters take a FilesAttachment: a local file from Get-Item, such as (Get-Item ./logo.png), or one New-FilesAttachment makes from a file, bytes or a stream. The file goes in the same request as the other parameters, whose values are sent exactly as they would be without it; a local file is opened, and a stream read, only when the command goes ahead with the change: never under -WhatIf or when a confirmation is declined. A stream is borrowed: the command leaves it open.
Examples
Example 1: Update Style
Writes the style as Files.com returns it.
Example 2: Act on styles from the pipeline
Takes the style from the pipeline and uses its Path and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Path
Style path.
- Type:
System.String - Parameter sets:
Path(required, position 0)
-File
Logo for custom branding. Required when creating a new style. Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
Path,InputObject
-LogoClickHref
URL to open when a public visitor clicks the logo.
- Type:
System.String - Parameter sets:
Path,InputObject
-InputObject
The style 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.Style - 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)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: Medium. At the default
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes it ask before each change.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
FilesCom.PowerShell.Models.Style: a style from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Style: the style 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.