PrivateFunctions/Rename-SlackChannel.ps1
|
<#
.SYNOPSIS This function renames a channel in Slack. .DESCRIPTION This function renames a channel in Slack. #> function Rename-SlackChannel { param( [CmdletBinding(PositionalBinding=$false)] [OutputType([Bool])] # The authentication token for Slack [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$token, # The name of the channel to rename [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$channelName, # The new name of the channel [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$newChannelName, # Select the stream where the messages will be directed. [Parameter(Mandatory=$false)] [ValidateSet("Information", "Warning", "Error", "None")] [String]$outputStream = "Error" ) # Convert channel name to channel ID verify that it exists $channelID = (Get-SlackChannel -Token $token -ChannelName $channelName).id if (!$channelID) { Write-OutputMessage "The channel '$($channelName)' cannot be found in Slack." -OutputStream $outputStream -ReturnMessage:$false return $false } # Prepare the API call parameters $invokeRestMethodParams = @{ Uri = "https://slack.com/api/channels.rename" Method = "POST" Headers = @{ "Content-Type" = "application/json" Authorization = "Bearer $($token)" } Body = @{ "channel" = "$($channelID)" "name" = "$($newChannelName)" } | ConvertTo-Json } # Try to rename the channel Write-Information "Renaming channel '$($channelName)'." try { $response = Invoke-RestMethod @invokeRestMethodParams } catch { Write-OutputMessage "Exception occurred while renaming the channel '$($channelName)'.`r`n$($_.Exception.Message)" -OutputStream $outputStream -ReturnMessage:$false return $false } # Verify that the renaming is successful if ($response.ok) { Write-Information "Channel '$($channelName)' was renamed to $($newChannelName)." return $true } else { Write-OutputMessage "Failed to rename channel '$($channelName)' with the error message:`r`n$($response.error)." -OutputStream $outputStream -ReturnMessage:$false return $false } } |