functions/SPClientFolder/Remove-SPClientFolder.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
#Requires -Version 3.0

<#
  Remove-SPClientFolder.ps1
 
  Copyright (c) 2017 karamem0
 
  This software is released under the MIT License.
  https://github.com/karamem0/SPClient/blob/master/LICENSE
#>


function Remove-SPClientFolder {

<#
.SYNOPSIS
  Deletes the folder.
.DESCRIPTION
  The Remove-SPClientFolder function removes the subfolder from the folder.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ClientObject
  Indicates the folder to delete.
.PARAMETER ParentObject
  Indicates the folder which the folders are contained.
.PARAMETER Name
  Indicates the folder name.
.PARAMETER Web
  Indicates the site which the folders are contained.
.PARAMETER Identity
  Indicates the folder GUID.
.PARAMETER Url
  Indicates the folder URL.
.EXAMPLE
  Remove-SPClientFolder $folder
.EXAMPLE
  Remove-SPClientFolder $folder -Name "Folder"
.EXAMPLE
  Remove-SPClientFolder -Web $web -Url "http://example.com/DocLib1/Folder"
.INPUTS
  None or SPClient.SPClientFolderParentPipeBind
.OUTPUTS
  None
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/Remove-SPClientFolder.md
#>


    [CmdletBinding(DefaultParameterSetName = 'ClientObject')]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ParameterSetName = 'ClientObject')]
        [Microsoft.SharePoint.Client.Folder]
        $ClientObject,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ParameterSetName = 'Name')]
        [SPClient.SPClientFolderParentPipeBind]
        $ParentObject,
        [Parameter(Mandatory = $true, ParameterSetName = 'Name')]
        [Alias('Title')]
        [string]
        $Name,
        [Parameter(Mandatory = $true, ParameterSetName = 'Identity')]
        [Parameter(Mandatory = $true, ParameterSetName = 'Url')]
        [Microsoft.SharePoint.Client.Web]
        $Web,
        [Parameter(Mandatory = $true, ParameterSetName = 'Identity')]
        [Alias('Id')]
        [guid]
        $Identity,
        [Parameter(Mandatory = $true, ParameterSetName = 'Url')]
        [string]
        $Url
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        if ($PSCmdlet.ParameterSetName -eq 'ClientObject') {
            if (-not $ClientObject.IsPropertyAvailable('ServerRelativeUrl')) {
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'UniqueId,ServerRelativeUrl'
            }
        } else {
            if ($PSCmdlet.ParameterSetName -eq 'Name') {
                $ClientObjectCollection = $ParentObject.ClientObject.Folders
                $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( `
                    $ClientContext, `
                    $ClientObjectCollection.Path, `
                    'GetByUrl', `
                    [object[]]$Name)
                $ClientObject = New-Object Microsoft.SharePoint.Client.Folder($ClientContext, $PathMethod)
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'UniqueId,ServerRelativeUrl'
                trap {
                    throw 'The specified folder could not be found.'
                }
            }
            if ($PSCmdlet.ParameterSetName -eq 'Identity') {
                $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( `
                    $ClientContext, `
                    $Web.Path, `
                    'GetFolderById', `
                    [object[]]$Identity)
                $ClientObject = New-Object Microsoft.SharePoint.Client.Folder($ClientContext, $PathMethod)
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'UniqueId,ServerRelativeUrl'
                trap {
                    throw 'The specified folder could not be found.'
                }
            }
            if ($PSCmdlet.ParameterSetName -eq 'Url') {
                $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( `
                    $ClientContext, `
                    $Web.Path, `
                    'GetFolderByServerRelativeUrl', `
                    [object[]]$Url)
                $ClientObject = New-Object Microsoft.SharePoint.Client.Folder($ClientContext, $PathMethod)
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'UniqueId,ServerRelativeUrl'
                trap {
                    throw 'The specified folder could not be found.'
                }
            }
        }
        $ClientObject.DeleteObject()
        $ClientContext.ExecuteQuery()
    }

}