Get-OfficeConfluenceAttachment

Namespace PSWriteOffice

Outputs

OfficeIMO.Confluence.ConfluenceAttachment OfficeIMO.Confluence.ConfluenceAttachmentBatch System.Byte[] System.IO.FileInfo

Source

Sources/PSWriteOffice/Cmdlets/Confluence/GetOfficeConfluenceAttachmentCommand.cs:19 Edit on GitHub

Lists or downloads Confluence page attachments.

Remarks

Lists or downloads Confluence page attachments.

Examples

Authored help example

Example 1: List all attachments for a page.

PS>


Get-OfficeConfluenceAttachment -Session $session -PageId 12345

Follows attachment cursors and streams attachment metadata.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-OfficeConfluenceAttachment [-AsPage] [-Cursor <String>] [-Limit <Int32>] -PageId <String> -Session <ConfluenceSession> [<CommonParameters>]

Parameter set: List

Parameters

AsPage SwitchParameter optionalposition: namedpipeline: False: Return attachment batches rather than individual metadata objects.
Cursor String optionalposition: namedpipeline: False: Optional cursor at which to resume attachment listing.
Limit Int32 optionalposition: namedpipeline: False: Maximum attachments requested per listing batch.
PageId String requiredposition: namedpipeline: False: Page identifier.
Session ConfluenceSession requiredposition: namedpipeline: False: Configured Confluence session.

Outputs

OfficeIMO.Confluence.ConfluenceAttachment, OfficeIMO.Confluence.ConfluenceAttachmentBatch, System.Byte[], System.IO.FileInfo

Get-OfficeConfluenceAttachment -AttachmentId <String> [-Force] [-OutFile <String>] -PageId <String> -Session <ConfluenceSession> [<CommonParameters>]

Parameter set: Download

Parameters

AttachmentId String requiredposition: namedpipeline: False: Attachment identifier to download.
Force SwitchParameter optionalposition: namedpipeline: False: Overwrite an existing destination file.
OutFile String optionalposition: namedpipeline: False: Optional destination path. Without this parameter, the download is returned as one byte array.
PageId String requiredposition: namedpipeline: False: Page identifier.
Session ConfluenceSession requiredposition: namedpipeline: False: Configured Confluence session.

Outputs

OfficeIMO.Confluence.ConfluenceAttachment, OfficeIMO.Confluence.ConfluenceAttachmentBatch, System.Byte[], System.IO.FileInfo