functions/Get-SPClientList.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
#Requires -Version 3.0

# Get-SPClientList.ps1
#
# Copyright (c) 2017 karamem0
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

function Get-SPClientList {

<#
.SYNOPSIS
  Gets SharePoint client list object.
.DESCRIPTION
  If not specified 'Identity', 'Url' and 'Title', returns all lists. Otherwise,
  returns a list which matches the parameter.
.PARAMETER ClientContext
  Indicates the SharePoint client context.
  If not specified, uses the default context.
.PARAMETER Web
  Indicates the SharePoint web object.
  If not specified, uses the default web.
.PARAMETER Identity
  Indicates the SharePoint list GUID to get.
.PARAMETER Url
  Indicates the SharePoint list relative url to get.
.PARAMETER Title
  Indicates the SharePoint list title or internal name to get.
.PARAMETER Retrievals
  Indicates the data retrieval expression.
#>


    [CmdletBinding(DefaultParameterSetName = 'All')]
    param (
        [Parameter(Mandatory = $false, ParameterSetName = 'All')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Identity')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Url')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Title')]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $false, ValueFromPipeline = $true, ParameterSetName = 'All')]
        [Parameter(Mandatory = $false, ValueFromPipeline = $true, ParameterSetName = 'Identity')]
        [Parameter(Mandatory = $false, ValueFromPipeline = $true, ParameterSetName = 'Url')]
        [Parameter(Mandatory = $false, ValueFromPipeline = $true, ParameterSetName = 'Title')]
        [Microsoft.SharePoint.Client.Web]
        $Web = $SPClient.ClientContext.Web,
        [Parameter(Mandatory = $true, ParameterSetName = 'Identity')]
        [Guid]
        $Identity,
        [Parameter(Mandatory = $true, ParameterSetName = 'Url')]
        [String]
        $Url,
        [Parameter(Mandatory = $true, ParameterSetName = 'Title')]
        [String]
        $Title,
        [Parameter(Mandatory = $false, ParameterSetName = 'All')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Identity')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Url')]
        [Parameter(Mandatory = $false, ParameterSetName = 'Title')]
        [String]
        $Retrievals
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        if ($Web -eq $null) {
            throw "Cannot bind argument to parameter 'Web' because it is null."
        }
        if ($PSCmdlet.ParameterSetName -eq 'All') {
            $lists = $Web.Lists
            Invoke-SPClientLoadQuery `
                -ClientContext $ClientContext `
                -ClientObject $lists `
                -Retrievals $Retrievals
            Write-Output @(,$lists)
        }
        if ($PSCmdlet.ParameterSetName -eq 'Identity') {
            $list = $Web.Lists.GetById($Identity)
            Invoke-SPClientLoadQuery `
                -ClientContext $ClientContext `
                -ClientObject $list `
                -Retrievals $Retrievals
            Write-Output $list
        }
        if ($PSCmdlet.ParameterSetName -eq 'Url') {
            $list = $Web.GetList($Url)
            Invoke-SPClientLoadQuery `
                -ClientContext $ClientContext `
                -ClientObject $list `
                -Retrievals $Retrievals
            Write-Output $list
        }
        if ($PSCmdlet.ParameterSetName -eq 'Title') {
            try {
                $list = $Web.Lists.GetByTitle($Title)
                Invoke-SPClientLoadQuery `
                    -ClientContext $ClientContext `
                    -ClientObject $list `
                    -Retrievals $Retrievals
            } catch {
                $lists = $Web.Lists
                Invoke-SPClientLoadQuery `
                    -ClientContext $ClientContext `
                    -ClientObject $lists `
                    -Retrievals 'Include(RootFolder.Name)'
                $list = $lists | Where-Object { $_.RootFolder.Name -eq $Title }
                if ($list -eq $null) {
                    throw $_
                }
                Invoke-SPClientLoadQuery `
                    -ClientContext $ClientContext `
                    -ClientObject $list `
                    -Retrievals $Retrievals
            }
            Write-Output $list
        }
    }

}