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

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


function Remove-SPClientAttachment {

<#
.SYNOPSIS
  Deletes the attachment.
.DESCRIPTION
  The Remove-SPClientAttachment function removes the attachment from the list item.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ClientObject
  Indicates the attachment to delete.
.PARAMETER ParentObject
  Indicates the list item which the attachment is contained.
.PARAMETER FileName
  Indicates the attachment file name.
.EXAMPLE
  Remove-SPClientAttachment $attachment
.EXAMPLE
  Remove-SPClientAttachment $item -FileName "CustomAttachment.xlsx"
.INPUTS
  None or Microsoft.SharePoint.Client.Attachment or SPClient.SPClientAttachmentParentPipeBind
.OUTPUTS
  None
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/Remove-SPClientAttachment.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.Attachment]
        $ClientObject,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ParameterSetName = 'FileName')]
        [SPClient.SPClientAttachmentParentPipeBind]
        $ParentObject,
        [Parameter(Mandatory = $true, ParameterSetName = 'FileName')]
        [string]
        $FileName
    )

    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('FileName')) {
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'FileName'
            }
        } else {
            $ClientObjectCollection = $ParentObject.ClientObject.AttachmentFiles
            if ($PSCmdlet.ParameterSetName -eq 'FileName') {
                $PathMethod = New-Object Microsoft.SharePoint.Client.ObjectPathMethod( `
                    $ClientContext, `
                    $ClientObjectCollection.Path, `
                    'GetByFileName', `
                    [object[]]$FileName)
                $ClientObject = New-Object Microsoft.SharePoint.Client.Attachment($ClientContext, $PathMethod)
                Invoke-ClientContextLoad `
                    -ClientContext $ClientContext `
                    -ClientObject $ClientObject `
                    -Retrieval 'FileName'
                trap {
                    throw 'The specified attachment could not be found.'
                }
            }
        }
        $ClientObject.DeleteObject()
        $ClientContext.ExecuteQuery()
    }

}