HaloAPI

1.9.1-Beta4

Output/HaloAPI/Public/Get/Get-HaloCustomButton.ps1

using module ..\..\Classes\Completers\HaloCustomButtonCompleter.psm1
using module ..\..\Classes\Validators\HaloCustomButtonValidator.psm1
using module ..\..\Classes\HaloCustomButton.psm1
#Requires -Version 7
function Get-HaloCustomButton {
    <#
        .SYNOPSIS
            Gets custom buttons from the Halo API.
        .DESCRIPTION
            Retrieves custom buttons from the Halo API - supports a variety of filtering parameters.
        .OUTPUTS
            A powershell object containing the response.
    #>
    [CmdletBinding( DefaultParameterSetName = 'Multi' )]
    [OutputType([Object])]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')]
    Param(
        # Custom Button ID.
        [Parameter( ParameterSetName = 'Single', Mandatory = $True )]
        [int64]$CustomButtonID,
        # Filter by the specified type.
        [Parameter( ParameterSetName = 'Multi' )]
        [ArgumentCompleter([HaloCustomButtonCompleter])]
        [ValidateSet([HaloCustomButtonValidator])]
        [string]$Type,
        # Filter by the specified type ID.
        [Parameter( ParameterSetName = 'Multi' )]
        [int64]$TypeID,
        # Include custom buttons which are setup (defaults to $True).
        [Parameter( ParameterSetName = 'Multi' )]
        [switch]$IsButtonSetup,
        # Include extra detail objects in the response.
        [Parameter( ParameterSetName = 'Single' )]
        [Parameter( ParameterSetName = 'Multi' )]
        [switch]$IncludeDetails
    )
    Invoke-HaloPreFlightChecks
    $CommandName = $MyInvocation.InvocationName
    $Parameters = (Get-Command -Name $CommandName).Parameters
    # Workaround to prevent the query string processor from adding an 'custombuttonid=' parameter by removing it from the set parameters.
    if ($CustomButtonID) {
        $Parameters.Remove('CustomButtonID') | Out-Null
    }
    $QSCollection = New-HaloQuery -CommandName $CommandName -Parameters $Parameters
    if ($Type) {
        $Parameters.Remove('Type')
        $TypeID = [HaloCustomButton]::ToID($Type)
        $QSCollection.Add('typeid', $TypeID)
    }
    try {
        if ($AgentID) {
            Write-Verbose "Running in single-custom button mode because '-CustomButtonID' was provided."
            $Resource = "api/custombutton/$($CustomButtonID)"
        } else {
            Write-Verbose 'Running in multi-custom button mode.'
            $Resource = 'api/custombutton'
        }
        $RequestParams = @{
            Method = 'GET'
            Resource = $Resource
            AutoPaginateOff = $True
            QSCollection = $QSCollection
            ResourceType = 'custombuttons'
        }
        $CustomButtonResults = New-HaloGETRequest @RequestParams
        Return $CustomButtonResults
    } catch {
        $Command = $CommandName -Replace '-', ''
        $ErrorRecord = @{
            ExceptionType = 'System.Exception'
            ErrorMessage = "$($CommandName) failed."
            InnerException = $_.Exception
            ErrorID = "Halo$($Command)CommandFailed"
            ErrorCategory = 'ReadError'
            TargetObject = $_.TargetObject
            ErrorDetails = $_.ErrorDetails
            BubbleUpDetails = $False
        }
        $CommandError = New-HaloErrorRecord @ErrorRecord
        $PSCmdlet.ThrowTerminatingError($CommandError)
    }
}