Public/Get-RyverForum.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
function Get-RyverForum { <# .SYNOPSIS Query for Ryver public forum channels. .DESCRIPTION Query for Ryver public forum channels. .INPUTS System.String .NOTES - Troy Lindsay - Twitter: @troylindsay42 - GitHub: tlindsay42 .EXAMPLE Get-RyverForum -ID 12345678 Queries for the public forum channel with ID 12345678. .EXAMPLE 12345678 | Get-RyverForum Queries for the public forum channel with ID 12345678 via pipeline value. .EXAMPLE Get-RyverForum 12345678 Queries for the public forum channel with ID 12345678 via positional parameter. .EXAMPLE Get-RyverForum -Name 'All Hands' Queries for the 'All Hands' public forum channel. .EXAMPLE Get-RyverForum -Name 'All Hand*' -Credential ( Get-Credential ) Updates the $Script:PSRyver.Authorization value storing the basic authentication authorization header to use for all requests and then queries for all public forum channels starting with the string 'All Hand', such as 'All Hands' and 'All handsome guys like that Troy fellow'. =D .EXAMPLE 'All Hands' | Get-RyverForum -Detailed Queries for detailed information about the 'All Hands' public forum channel via the pipeline. .EXAMPLE '*and*' | Get-RyverForum -Raw Queries for all public forum channels containing the string 'and', such as 'All Hands' and 'The Land of Magical Unicorns' and returns the raw, unformatted output. .EXAMPLE Get-RyverForum 'All Hands' $true $true Queries for detailed information about the 'All Hands' public forum channel via positional parameters and returns the raw, unformatted output. .EXAMPLE [PSCustomObject] @{ ID = [UInt64] 12345678 } | Get-RyverForum Queries for the public forum channel with ID 12345678 via pipeline parameter name. .EXAMPLE [PSCustomObject] @{ Name = 'All Hands' } | Get-RyverForum Queries for the 'All Hands' public forum channel via pipeline parameter name. .LINK https://tlindsay42.github.io/PSRyver/Public/Get-RyverForum/ .LINK https://github.com/tlindsay42/PSRyver/blob/master/PSRyver/Public/Get-RyverForum.ps1 .FUNCTIONALITY Ryver #> [CmdletBinding( HelpUri = 'https://tlindsay42.github.io/PSRyver/Public/Get-RyverForum/', DefaultParameterSetName = 'ID', SupportsPaging = $true )] [OutputType( [PSCustomObject[]] )] [OutputType( [PSCustomObject] )] param ( # Specifies the public forum channel ID. [Parameter( ParameterSetName = 'ID', Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [UInt64] $ID, # Specifies the public forum channel name. Case insensitive. [Parameter( ParameterSetName = 'Name', Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )] [SupportsWildcards()] [String] $Name, # Specifies whether to retrieve additional details about each object. [Parameter( Position = 1, ValueFromPipelineByPropertyName = $true )] [Switch] $Detailed, # Specifies that objects should not be formatted. [Parameter( Position = 2, ValueFromPipelineByPropertyName = $true )] [Switch] $Raw, <# Credentials to use for the Ryver API. Default value is the value set by Set-PSRyverConfig. #> [Parameter( Position = 3 )] [PSCredential] $Credential ) begin { $function = $MyInvocation.MyCommand.Name Write-Verbose -Message "Beginning: '${function}'." #region init $return = @() $detailedProperties = @( 'board/id', 'createUser/*', 'modifyUser/*', 'securityGroup/*', 'administratorsGroup/*', 'moderatorsGroup/*', 'members/*', 'acl/id', 'externalLinks/*' ) $detailedPropertiesSelect = ( $detailedProperties | ForEach-Object -Process { [System.Web.HttpUtility]::UrlEncodeUnicode( $_ ) } ) -join ',' $detailedPropertiesExpand = ( $detailedProperties | ForEach-Object -Process { $_.Split( '/' )[0] } ) -join ',' $first = $PSCmdlet.PagingParameters.Skip $last = $first + $PSCmdlet.PagingParameters.First #endregion Write-Verbose -Message "First index position: '${first}'." if ( $PSBoundParameters.ContainsKey( 'Credential' ) ) { $Script:PSRyver.Authorization = ConvertTo-Authorization -Credential $Credential Remove-Variable -Name 'Credential' } Assert-RyverApiConfig if ( $PSCmdlet.PagingParameters.First -eq 0 ) { Write-Verbose -Message "The 'First' parameter is set to accept zero results- terminating." break } } process { Write-Verbose -Message ( "Processing: '${function}' with ParameterSetName '$( $PSCmdlet.ParameterSetName )' and Parameters: " + ( $PSBoundParameters | Remove-SensitiveData | Format-Table -AutoSize -Wrap | Out-String ) ) #region init $skip = 0 $count = [UInt64]::MaxValue $objects = @() #endregion #region Build the URI path if ( $ID ) { $path = "/forums(${ID})?" } else { $path = '/forums?' if ( $PSBoundParameters.ContainsKey( 'Name' ) ) { $path += "`$search=$( [System.Web.HttpUtility]::UrlEncodeUnicode( $Name ) )&" } } $path += '$select=*' if ( $Detailed -eq $true ) { $path += ( ",${detailedPropertiesSelect}" + "&`$expand=${detailedPropertiesExpand}" ) } $path += ( "&`$top=$( $Script:PSRyver.MaxPageSize )" + "&`$skip=${skip}" + '&$orderby=name+asc' + '&$inlinecount=allpages' ) #endregion $splat = @{ Method = 'Get' Path = $path ErrorAction = 'Stop' } while ( $return.Count -lt $last -and $skip -lt $count ) { $response = Invoke-RyverRestMethod @splat [UInt64] $count = $response.D.__Count Write-Verbose -Message "Found '${count}' objects." Write-Verbose -Message "Queried for objects '${skip}-$( $skip + $Script:PSRyver.MaxPageSize )'." $tempObjects = $response | Select-Object -ExpandProperty 'D' | Select-Object -ExpandProperty 'Results' if ( $Name ) { Write-Verbose -Message "Received '$( ( $tempObjects | Measure-Object ).Count )' objects with server-side filtering." $tempObjects = $tempObjects | Where-Object -FilterScript { $_.__Descriptor -like $Name } Write-Verbose -Message "Filtered to '$( ( $tempObjects | Measure-Object ).Count )' objects after client-side filtering." } $objects += $tempObjects $skip += $Script:PSRyver.MaxPageSize $splat.Path = $path -replace '\$skip=\d+', "`$skip=${skip}" $return += $objects } Write-Verbose -Message "Added '$( ( $objects | Measure-Object ).Count )' objects in this Process cycle." } end { $count = ( $return | Measure-Object ).Count if ( $count -gt 0 ) { if ( $PSCmdlet.PagingParameters.Skip -ge $count ) { Write-Verbose -Message "Insufficient results: '${count}' to satisfy the 'Skip' parameter value: '${first}'." $return = $null } else { $last = $first + [Math]::Min( $PSCmdlet.PagingParameters.First, $count - $PSCmdlet.PagingParameters.Skip ) - 1 Write-Verbose -Message "Last index position: '${last}'." if ( $first -le $last ) { $return = $return[$first..$last] if ( $Raw -eq $true ) { $return } else { $return | Format-RyverChannelObject } } else { $return = $null } } } $count = ( $return | Measure-Object ).Count Write-Verbose -Message "Returned '${count}' objects." if ( $PSCmdlet.PagingParameters.IncludeTotalCount ) { $PSCmdlet.PagingParameters.NewTotalCount( $count, 1.0 ) } Write-Verbose -Message "Ending: '${function}'." } } |