# ConfluenceClient

Dependency-light Confluence Cloud page and attachment client.

Class 

`OfficeIMO.Confluence`

**Namespace**

`OfficeIMO.Confluence`

**Assembly**

`OfficeIMO.Confluence`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ConfluenceClient.Pages.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L12)

**Implements**

`IDisposable`

**Modifiers**

sealed

Dependency-light Confluence Cloud page and attachment client.

## Inheritance

- object
- ConfluenceClient

## Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 1

- Method [ConfluenceSession.CreateClient](/api/confluence/officeimo-confluence-confluencesession/#method-createclient)

Filter members 

Show inherited

## Constructors

`public ConfluenceClient(ConfluenceSession session)` [#](#constructor-ctor-officeimo-confluence-confluencesession)

[ConfluenceClient.Pages.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L12)

Creates a client that sends requests using the supplied session.

Parameters

**session OfficeIMO.Confluence.ConfluenceSession required**

## Methods

`public Task<ConfluencePage> CreatePageAsync(ConfluencePageCreateRequest request, CancellationToken cancellationToken = default)` [#](#method-createpageasync-officeimo-confluence-confluencepagecreaterequest-threading-cancellationtoken)

[ConfluenceClient.Pages.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L37)

Creates a page. Non-idempotent writes are never retried automatically.

Parameters

**request OfficeIMO.Confluence.ConfluencePageCreateRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<ConfluencePage>`

`public async Task DeletePageAsync(string pageId, bool purge = false, bool draft = false, CancellationToken cancellationToken = default)` [#](#method-deletepageasync-string-boolean-boolean-threading-cancellationtoken)

Deletes a page. This non-idempotent operation is never retried automatically.

Parameters

**pageId string required**

**purge bool = false optional**

**draft bool = false optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

`public void Dispose()` [#](#method-dispose)

[ConfluenceClient.Pages.cs:99](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L99)

Releases the client's resources without disposing a caller-supplied HTTP client.

DownloadAttachmentAsync 2 overloads

`public async Task<byte[]> DownloadAttachmentAsync(string pageId, string attachmentId, CancellationToken cancellationToken = default)` [#](#method-downloadattachmentasync-string-string-threading-cancellationtoken)

Downloads an attachment through Confluence's authenticated redirect endpoint.

Parameters

**pageId string required**

**attachmentId string required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<byte[]>`

`public Task DownloadAttachmentAsync(string pageId, string attachmentId, Stream destination, CancellationToken cancellationToken = default)` [#](#method-downloadattachmentasync-string-string-io-stream-threading-cancellationtoken)

[ConfluenceClient.Attachments.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Attachments.cs#L30)

Streams an attachment through Confluence's authenticated redirect endpoint.

Parameters

**pageId string required**

**attachmentId string required**

**destination System.IO.Stream required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task`

`public async Task<ConfluenceAttachmentBatch> GetAttachmentsAsync(string pageId, string? cursor = null, int limit = 50, CancellationToken cancellationToken = default)` [#](#method-getattachmentsasync-string-string-int32-threading-cancellationtoken)

Lists one cursor-addressable batch of attachments for a page.

Parameters

**pageId string required**

**cursor string? = null optional**

**limit int = 50 optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<ConfluenceAttachmentBatch>`

`public Task<ConfluencePage> GetPageAsync(string pageId, ConfluenceBodyFormat bodyFormat = AtlasDocFormat, CancellationToken cancellationToken = default)` [#](#method-getpageasync-string-officeimo-confluence-confluencebodyformat-threading-cancellationtoken)

[ConfluenceClient.Pages.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L22)

Reads a page with the requested body representation.

Parameters

**pageId string required**

**bodyFormat OfficeIMO.Confluence.ConfluenceBodyFormat = AtlasDocFormat optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<ConfluencePage>`

`public async Task<ConfluencePageBatch> GetPagesAsync(ConfluencePageQuery? query = null, CancellationToken cancellationToken = default)` [#](#method-getpagesasync-officeimo-confluence-confluencepagequery-threading-cancellationtoken)

Lists one cursor-addressable batch of pages.

Parameters

**query OfficeIMO.Confluence.ConfluencePageQuery? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<ConfluencePageBatch>`

`public static ConfluencePageWritePlan PlanCreatePage(ConfluencePageCreateRequest request)` [#](#method-plancreatepage-officeimo-confluence-confluencepagecreaterequest)

[ConfluenceClient.Pages.cs:57](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L57)

Builds the exact create request without contacting Confluence.

Parameters

**request OfficeIMO.Confluence.ConfluencePageCreateRequest required**

Returns

`ConfluencePageWritePlan`

`public static ConfluencePageWritePlan PlanDeletePage(string pageId, bool purge = false, bool draft = false)` [#](#method-plandeletepage-string-boolean-boolean)

[ConfluenceClient.Pages.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L90)

Builds the exact delete request without contacting Confluence.

Parameters

**pageId string required**

**purge bool = false optional**

**draft bool = false optional**

Returns

`ConfluencePageWritePlan`

`public static ConfluencePageWritePlan PlanUpdatePage(ConfluencePageUpdateRequest request)` [#](#method-planupdatepage-officeimo-confluence-confluencepageupdaterequest)

[ConfluenceClient.Pages.cs:73](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L73)

Builds the exact update request without contacting Confluence.

Parameters

**request OfficeIMO.Confluence.ConfluencePageUpdateRequest required**

Returns

`ConfluencePageWritePlan`

`public Task<ConfluencePage> UpdatePageAsync(ConfluencePageUpdateRequest request, CancellationToken cancellationToken = default)` [#](#method-updatepageasync-officeimo-confluence-confluencepageupdaterequest-threading-cancellationtoken)

[ConfluenceClient.Pages.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L44)

Updates a page using the caller-supplied next version number. Writes are never retried automatically.

Parameters

**request OfficeIMO.Confluence.ConfluencePageUpdateRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<ConfluencePage>`

UploadAttachmentAsync 2 overloads

`public async Task<IReadOnlyList<ConfluenceAttachment>> UploadAttachmentAsync(string pageId, ConfluenceAttachmentUpload upload, CancellationToken cancellationToken = default)` [#](#method-uploadattachmentasync-string-officeimo-confluence-confluenceattachmentupload-threading-cancellationtoken)

Creates or versions an attachment through Confluence's multipart v1 endpoint.

Parameters

**pageId string required**

**upload OfficeIMO.Confluence.ConfluenceAttachmentUpload required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<IReadOnlyList<ConfluenceAttachment>>`

`public async Task<IReadOnlyList<ConfluenceAttachment>> UploadAttachmentAsync(string pageId, ConfluenceAttachmentStreamUpload upload, CancellationToken cancellationToken = default)` [#](#method-uploadattachmentasync-string-officeimo-confluence-confluenceattachmentstreamupload-threading-cancellationtoken)

Creates or versions an attachment from a caller-owned stream.

Parameters

**pageId string required**

**upload OfficeIMO.Confluence.ConfluenceAttachmentStreamUpload required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<IReadOnlyList<ConfluenceAttachment>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public ConfluenceSession Session { get; }` [#](#property-session)

[ConfluenceClient.Pages.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Confluence/ConfluenceClient.Pages.cs#L18)

Gets the session supplied to this client.

<!-- PowerForge markdown artifact sha256:05D190573E85EC4D712FB02610CFB3ACF0A23CDF77DFDE29FCC55E16E020B4C6 -->
