Public/Remove-SlackReminder.ps1
|
function Remove-SlackReminder { <# .SYNOPSIS Deletes a Slack reminder .DESCRIPTION Deletes a Slack reminder based on the reminder object or reminder id passed to the function .PARAMETER Token Token to use for the Slack API Default value is the value set by Set-PSSlackConfig This takes precedence over Uri .PARAMETER Proxy Proxy server to use Default value is the value set by Set-PSSlackConfig .PARAMETER ReminderId The ID of the reminder that will be deleted. .PARAMETER ReminderObject One or more objects of type PSSlack.Reminder. This is intended for use in pipelined scenarios. .EXAMPLE # This is a simple example on how to remove a reminder by passing its ID Remove-SlackReminder -ReminderId "RmAZPB1FBP" # Removes a reminder with an ID of "RmAZPB1FBP" .EXAMPLE # This is a simple example on how to remove a reminder by searching and filtering the existing reminders # The returned reminder object is then passed to Remove-SlackReminder New-SlackReminder -Text "you should delete me soon" -Time (get-date).AddMinutes(10) Get-SlackReminder | Where-Object {$_.Text -like "*delete me*"} | Remove-SlackReminder # We create a reminder # We then search for that reminder and delete it by piping it into Remove-SlackReminder .EXAMPLE # This is a simple example on how to remove multiple reminders by searching and filtering the existing reminders # The returned reminder object array is then passed to Remove-SlackReminder New-SlackReminder -Text "you should delete me soon" -Time (get-date).AddMinutes(10) New-SlackReminder -Text "you should delete me soon too" -Time (get-date).AddMinutes(10) Get-SlackReminder | Where-Object {$_.Text -like "*delete me*"} | Remove-SlackReminder # We create two reminders # We then search for the reminders and delete them by piping them into Remove-SlackReminder .LINK https://api.slack.com/methods/reminders.delete .FUNCTIONALITY Slack #> [CmdletBinding(DefaultParameterSetName = 'ByParameter')] param ( [Parameter()] [ValidateNotNullOrEmpty()] [string]$Token = $Script:PSSlack.Token, [Parameter()] [ValidateNotNullOrEmpty()] [string]$Proxy = $Script:PSSlack.Proxy, [Parameter(ValueFromPipeline = $True)] [Parameter(ParameterSetName = 'ByObject')] [PSTypeName('PSSlack.Reminder')] $ReminderObject, [Parameter(ParameterSetName = 'ByParameter')] [Alias("Reminder")] [string]$ReminderId ) begin { $ProxyParam = @{} if ($Proxy) { $ProxyParam.Proxy = $Proxy } } process { if ($ReminderObject) { foreach ($object in $ReminderObject) { $body = @{ } $body.reminder = $object.ID Write-Verbose "Send-SlackApi" Send-SlackApi @ProxyParam -Method reminders.delete -Body $body -Token $Token -ForceVerbose:$ForceVerbose } } else { $body = @{ } $body.reminder = $ReminderId Write-Verbose "Send-SlackApi" Send-SlackApi @ProxyParam -Method reminders.delete -Body $body -Token $Token -ForceVerbose:$ForceVerbose } } } |