Get-OfficeConfluencePage

Namespace PSWriteOffice

Outputs

OfficeIMO.Confluence.ConfluenceContentConversionResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

OfficeIMO.Confluence.ConfluencePage OfficeIMO.Confluence.ConfluencePageBatch

Source

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

Reads one page or streams a filtered Confluence Cloud page listing.

Remarks

Reads one page or streams a filtered Confluence Cloud page listing.

Examples

Authored help example

Example 1: Read a page as Markdown with fidelity evidence.

PS>


Get-OfficeConfluencePage -Session $session -PageId 12345 -AsMarkdown

Returns the converted Markdown value and its ADF conversion report.

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-OfficeConfluencePage [-AsHtml] [-AsMarkdown] [-AsPage] [-BodyFormat <Storage|AtlasDocFormat>] [-Cursor <String>] [-FailOnLoss] [-Limit <Int32>] -Session <ConfluenceSession> [-SpaceId <String>] [-Title <String>] [<CommonParameters>]

Parameter set: List

Parameters

AsHtml SwitchParameter optionalposition: namedpipeline: False: Project each page body to HTML and include conversion evidence.
AsMarkdown SwitchParameter optionalposition: namedpipeline: False: Project each page body to Markdown and include conversion evidence.
AsPage SwitchParameter optionalposition: namedpipeline: False: Return listing batches rather than enumerating their pages.
BodyFormat ConfluenceBodyFormat optionalposition: namedpipeline: Falsevalues: 2: Body representation requested from Confluence. Possible values: Storage, AtlasDocFormat; Possible values: Storage, AtlasDocFormat
Cursor String optionalposition: namedpipeline: False: Optional cursor at which to resume a page listing.
FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when a requested projection reports reduced fidelity.
Limit Int32 optionalposition: namedpipeline: False: Maximum pages requested in each listing batch.
Session ConfluenceSession requiredposition: namedpipeline: False: Configured Confluence session.
SpaceId String optionalposition: namedpipeline: False: Optional space identifier used when listing pages.
Title String optionalposition: namedpipeline: False: Optional exact title used when listing pages.

Outputs

OfficeIMO.Confluence.ConfluenceContentConversionResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], OfficeIMO.Confluence.ConfluencePage, OfficeIMO.Confluence.ConfluencePageBatch

Get-OfficeConfluencePage [-AsHtml] [-AsMarkdown] [-BodyFormat <Storage|AtlasDocFormat>] [-FailOnLoss] -PageId <String> -Session <ConfluenceSession> [<CommonParameters>]

Parameter set: ById

Parameters

AsHtml SwitchParameter optionalposition: namedpipeline: False: Project each page body to HTML and include conversion evidence.
AsMarkdown SwitchParameter optionalposition: namedpipeline: False: Project each page body to Markdown and include conversion evidence.
BodyFormat ConfluenceBodyFormat optionalposition: namedpipeline: Falsevalues: 2: Body representation requested from Confluence. Possible values: Storage, AtlasDocFormat; Possible values: Storage, AtlasDocFormat
FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when a requested projection reports reduced fidelity.
PageId String requiredposition: 0pipeline: False: Page identifier.
Session ConfluenceSession requiredposition: namedpipeline: False: Configured Confluence session.