MacNotify.psm1
|
Function Invoke-AlerterNotification { <# .SYNOPSIS Triggers an alerter notification to appear in OSX with the specified message and optional title, subtitle and sound alert. .DESCRIPTION This cmdlet is a PowerShell wrapper for the application 'alerter' command to trigger a custom notification to be displayed on OSX and handle a response/action. .PARAMETER Message The message text you want to appear in the notification. This parameter is mandatory. .PARAMETER Title Optional: The title text you want to appear in the notification. .PARAMETER Subtitle Optional: The subtitle text you want to appear in the notification. .PARAMETER Sound OptionaL: The alert sound you want to play when the notification appears. Must be one of the sounds from the default alert sounds paths: '/System/Library/Sounds/','/Library/Sounds','~/Library/Sounds'. .PARAMETER Timeout Optional: Number of seconds to wait before dismissing the notification automatically. Default: waits indefinitely. .PARAMETER AppIcon Optional: The path or URL to an image to display as the application icon for the notification. Alias: Icon .PARAMETER ContentImage Optional: The path or URL to an image to display attached to the notification. .PARAMETER Open Optional: A file or URL path to open if the 'show' button of the notification is clicked. .PARAMETER Raw Switch: Return raw text output instead of PowerShell Object output. .PARAMETER Silent Switch: Use to not return any object output. .EXAMPLE Invoke-AlerterNotification -Message "Click 'Show' to open Google." -Open 'https://www.google.com' .EXAMPLE Invoke-AlerterNotification -Message 'Hello! -Title 'Hello Message' -Subtitle ':)' -Timeout 30 -AppIcon 'http://url.to/an/icon.png' .EXAMPLE Invoke-AlerterNotification -Message 'Hello!' -Sound 'Ping' .EXAMPLE 1,2,3 | Invoke-AlerterNotification -Title 'Numbers' #> [cmdletbinding(SupportsShouldProcess)] param( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [String[]] $Message, [String] $Title = 'PowerShell Notification', [String] $Subtitle, [ValidateSet('Basso','Blow','Bottle','Frog','Funk','Glass','Hero','Morse','Ping','Pop','Purr','Sosumi','Submarine','Tink')] [String] $Sound, [Int32] $Timeout, [alias("Icon")] [String] $AppIcon, [String] $ContentImage, [String] $Open, [Switch] $Raw, [Switch] $Silent ) Begin { } Process { ForEach ($MessageText in $Message) { $CommandString = "-message '$MessageText'" if ($Title) { $CommandString = $CommandString + " -title '$Title'" } if ($Subtitle) { $CommandString = $CommandString + " -subtitle '$Subtitle'" } if ($Sound) { $CommandString = $CommandString + " -sound '$Sound'" } if ($Timeout) { $CommandString = $CommandString + " -timeout $Timeout" } if ($AppIcon) { $CommandString = $CommandString + " -appIcon '$AppIcon'" } if ($ContentImage) { $CommandString = $CommandString + " -contentImage '$ContentImage'" } if (-not $Raw) { $CommandString = $CommandString + " -json" } if ($PSCmdlet.ShouldProcess('Invoke-Alerter', "alerter $CommandString")) { $Result = Invoke-Alerter -Command $CommandString if (-not $Raw) { $Result = $Result | ConvertFrom-Json if ($Result.deliveredAt) { $Result.deliveredAt = Get-Date $Result.deliveredAt } if ($Result.activationAt) { $Result.activationAt = Get-Date $Result.activationAt } } if ($Open) { if ($Result.activationType -eq 'actionClicked' -or $Result -eq '@ACTIONCLICKED') { Invoke-Expression "open $Open" } } if (-not $Silent) { Return $Result } } } } } Function Invoke-MacNotification { <# .SYNOPSIS Triggers a notification to appear in OSX with the specified message and optional title, subtitle and sound alert. .DESCRIPTION This cmdlet is a PowerShell wrapper for the applescript 'display notification' command to trigger a custom notification to be displayed on OSX. .PARAMETER Message The message text you want to appear in the notification. This parameter is mandatory. .PARAMETER Title Optional: The title text you want to appear in the notification. .PARAMETER Subtitle Optional: The subtitle text you want to appear in the notification. .PARAMETER Sound OptionaL: The alert sound you want to play when the notification appears. Must be one of the sounds from the default alert sounds paths: '/System/Library/Sounds/','/Library/Sounds','~/Library/Sounds'. .EXAMPLE Invoke-MacNotification -Message 'Hello!' .EXAMPLE Invoke-MacNotification -Message 'Hello! -Title 'Hello Message' .EXAMPLE Invoke-MacNotification -Message 'Hello!' -Sound 'Ping' .EXAMPLE 1,2,3 | Invoke-MacNotification -Title 'Numbers' #> [cmdletbinding(SupportsShouldProcess)] param( [Parameter(Mandatory,ValueFromPipeline,Position=0)] [String[]] $Message, [String] $Title = 'PowerShell Notification', [String] $Subtitle, [ValidateSet('Basso','Blow','Bottle','Frog','Funk','Glass','Hero','Morse','Ping','Pop','Purr','Sosumi','Submarine','Tink')] [String] $Sound ) Begin { } Process { ForEach ($MessageText in $Message) { $CommandString = "display notification `"$MessageText`"" if ($Title) { $CommandString = $CommandString + " with title `"$Title`""} if ($Subtitle) { $CommandString = $CommandString + " subtitle `"$Subtitle`""} if ($Sound) { $CommandString = $CommandString + " sound name `"$Sound`""} If ($PSCmdlet.ShouldProcess('Invoke-AppleScript',$CommandString)) { Invoke-AppleScript $CommandString } } } } Function Invoke-Alerter { <# .SYNOPSIS Executes an alert string via Alerter. #> [cmdletbinding(SupportsShouldProcess)] param( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [String] $Command ) Begin { $CommandPath = (Resolve-Path "$PSScriptRoot/../Bin/alerter").Path } Process { If ($PSCmdlet.ShouldProcess('Invoke-Expression',"$CommandPath $Command")){ Invoke-Expression "$CommandPath $Command" } } } Function Invoke-AppleScript { <# .SYNOPSIS Executes a command string via Apple Script. #> [cmdletbinding(SupportsShouldProcess)] param( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [String] $Command ) Begin { } Process { If ($PSCmdlet.ShouldProcess('/usr/bin/osascript -e',$Command)){ /usr/bin/osascript -e $Command } } } |