New-FilesNotification
Create Notification.
Syntax
Description
Create Notification.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.
Examples
Example 1: Create Notification
Writes the notification returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-UserId
The id of the user to notify. Provide user_id, username or group_id.
- Type:
System.Int64 - Parameter sets:
(All)
-NotifyOnCopy
If true, copying or moving resources into this path will trigger a notification, in addition to just uploads.
- Type:
System.Boolean - Parameter sets:
(All)
-NotifyOnDelete
Trigger on files deleted in this path?
- Type:
System.Boolean - Parameter sets:
(All)
-NotifyOnDownload
Trigger on files downloaded in this path?
- Type:
System.Boolean - Parameter sets:
(All)
-NotifyOnMove
Trigger on files moved to this path?
- Type:
System.Boolean - Parameter sets:
(All)
-NotifyOnUpload
Trigger on files created/uploaded/updated/changed in this path?
- Type:
System.Boolean - Parameter sets:
(All)
-NotifyUserActions
If true actions initiated by the user will still result in a notification
- Type:
System.Boolean - Parameter sets:
(All)
-Recursive
If true, enable notifications for each subfolder in this path
- Type:
System.Boolean - Parameter sets:
(All)
-SendInterval
The time interval that notifications are aggregated by. Can be five_minutes, fifteen_minutes, hourly, or daily.
- Type:
System.String - Parameter sets:
(All)
-Subject
Custom subject line to use for notification emails
- Type:
System.String - Parameter sets:
(All)
-Message
Custom message to include in notification emails
- Type:
System.String - Parameter sets:
(All)
-TriggeringFilenames
Array of filenames (possibly with wildcards) to scope trigger
- Type:
System.String[] - Parameter sets:
(All)
-TriggeringGroupIds
If set, will only notify on actions made by a member of one of the specified groups
- Type:
System.Int64[] - Parameter sets:
(All)
-TriggeringUserIds
If set, will only notify on actions made one of the specified users
- Type:
System.Int64[] - Parameter sets:
(All)
-TriggerByShareRecipients
Notify when actions are performed by a share recipient?
- Type:
System.Boolean - Parameter sets:
(All)
-WorkspaceId
Workspace ID. 0 means the default workspace.
- Type:
System.Int64 - Parameter sets:
(All)
-GroupId
The ID of the group to notify. Provide user_id, username or group_id.
- Type:
System.Int64 - Parameter sets:
(All)
-GroupIds
Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited. Give the values as an array; the module joins them as the API expects.
- Type:
System.Int64[] - Parameter sets:
(All)
-Path
Path
- Type:
System.String - Parameter sets:
(All)
-Username
The username of the user to notify. Provide user_id, username or group_id.
- Type:
System.String - Parameter sets:
(All)
-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
None. The command takes no pipeline input.
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.