Set-FilesNotification
Update Notification.
Syntax
Id (Default)
InputObject
Description
Update Notification.
The command accepts notifications from the pipeline as -InputObject, and uses each one's Id 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.
Examples
Example 1: Update Notification
Writes the notification as Files.com returns it.
Example 2: Act on notifications from the pipeline
Takes the notification from the pipeline and uses its Id and connection.
Example 3: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Id
Notification ID.
- Type:
System.Int64 - Parameter sets:
Id(required, position 0)
-NotifyOnCopy
If true, copying or moving resources into this path will trigger a notification, in addition to just uploads.
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-NotifyOnDelete
Trigger on files deleted in this path?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-NotifyOnDownload
Trigger on files downloaded in this path?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-NotifyOnMove
Trigger on files moved to this path?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-NotifyOnUpload
Trigger on files created/uploaded/updated/changed in this path?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-NotifyUserActions
If true actions initiated by the user will still result in a notification
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-Recursive
If true, enable notifications for each subfolder in this path
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-SendInterval
The time interval that notifications are aggregated by. Can be five_minutes, fifteen_minutes, hourly, or daily.
- Type:
System.String - Parameter sets:
Id,InputObject
-Subject
Custom subject line to use for notification emails
- Type:
System.String - Parameter sets:
Id,InputObject
-Message
Custom message to include in notification emails
- Type:
System.String - Parameter sets:
Id,InputObject
-TriggeringFilenames
Array of filenames (possibly with wildcards) to scope trigger
- Type:
System.String[] - Parameter sets:
Id,InputObject
-TriggeringGroupIds
If set, will only notify on actions made by a member of one of the specified groups
- Type:
System.Int64[] - Parameter sets:
Id,InputObject
-TriggeringUserIds
If set, will only notify on actions made one of the specified users
- Type:
System.Int64[] - Parameter sets:
Id,InputObject
-TriggerByShareRecipients
Notify when actions are performed by a share recipient?
- Type:
System.Boolean - Parameter sets:
Id,InputObject
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - Parameter sets:
Id,InputObject
-InputObject
The notification to act on, such as one written by another command of the module, from the pipeline. The command uses its Id and the connection that fetched it.
- Type:
FilesCom.PowerShell.Models.Notification - 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.Notification: a notification from another command of the module, as-InputObject.
Outputs
FilesCom.PowerShell.Models.Notification: the notification 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.