functions/SPClientAttachment/New-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
90
91
92
93
94
95
#Requires -Version 3.0

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


function New-SPClientAttachment {

<#
.SYNOPSIS
  Creates a new attachment.
.DESCRIPTION
  The New-SPClientAttachment function adds a new attachment to the list item.
.PARAMETER ClientContext
  Indicates the client context. If not specified, uses default context.
.PARAMETER ParentObject
  Indicates the list item which a attachment to be created.
.PARAMETER ContentPath
  Indicates the content file path.
.PARAMETER ContentStream
  Indicates the content stream.
.PARAMETER FileName
  Indicates the file name.
.PARAMETER Retrieval
  Indicates the data retrieval expression.
.EXAMPLE
  New-SPClientAttachment $item -Name "CustomAttachment.xlsx" -ContentStream $stream
.EXAMPLE
  New-SPClientAttachment $item -ContentPath "C:\Users\admin\Documents\CustomAttachment.xlsx"
.INPUTS
  None or SPClient.SPClientAttachmentParentPipeBind
.OUTPUTS
  Microsoft.SharePoint.Client.Attachment
.LINK
  https://github.com/karamem0/SPClient/blob/master/doc/New-SPClientAttachment.md
#>


    [CmdletBinding(DefaultParameterSetName = 'ContentStream')]
    param (
        [Parameter(Mandatory = $false)]
        [Microsoft.SharePoint.Client.ClientContext]
        $ClientContext = $SPClient.ClientContext,
        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
        [SPClient.SPClientAttachmentParentPipeBind]
        $ParentObject,
        [Parameter(Mandatory = $true, ParameterSetName = 'ContentStream')]
        [System.IO.Stream]
        $ContentStream,
        [Parameter(Mandatory = $true, ParameterSetName = 'ContentPath')]
        [string]
        $ContentPath,
        [Parameter(Mandatory = $true, ParameterSetName = 'ContentStream')]
        [Parameter(Mandatory = $false, ParameterSetName = 'ContentPath')]
        [string]
        $Name,
        [Parameter(Mandatory = $false)]
        [string]
        $Retrieval
    )

    process {
        if ($ClientContext -eq $null) {
            throw "Cannot bind argument to parameter 'ClientContext' because it is null."
        }
        $Creation = New-Object Microsoft.SharePoint.Client.AttachmentCreationInformation
        if ($PSCmdlet.ParameterSetName -eq 'ContentStream') {
            $Creation.ContentStream = $ContentStream
            $Creation.FileName = $Name
        }
        if ($PSCmdlet.ParameterSetName -eq 'ContentPath') {
            if (-not (Test-Path -Path $ContentPath)) {
                throw "Cannot find file '$($ContentPath)'."
            }
            $Creation.ContentStream = [System.IO.File]::OpenRead($ContentPath)
            if ($PSBoundParameters.ContainsKey('Name')) {
                $Creation.FileName = $Name
            } else {
                $Creation.FileName = [System.IO.Path]::GetFileName($ContentPath)
            }
        }
        $ClientObject = $ParentObject.ClientObject.AttachmentFiles.Add($Creation)
        Invoke-ClientContextLoad `
            -ClientContext $ClientContext `
            -ClientObject $ClientObject `
            -Retrieval $Retrieval
        Write-Output $ClientObject
    }

}