Interface IConfluenceClient

The is the interface to the base client functionality of the Confluence API

Namespace: Dapplo.Confluence

Assembly: Dapplo.Confluence.dll

Syntax

public interface IConfluenceClient

Properties

| Improve this Doc View Source

Attachment

The attachment domain

Declaration

IAttachmentDomain Attachment { get; }

Property Value

Type	Description
IAttachmentDomain

| Improve this Doc View Source

ConfluenceApiUri

The base URI for your Confluence server api calls

Declaration

Uri ConfluenceApiUri { get; }

Property Value

Type	Description
Uri

| Improve this Doc View Source

ConfluenceUri

The base URI for your Confluence server downloads

Declaration

Uri ConfluenceUri { get; }

Property Value

Type	Description
Uri

| Improve this Doc View Source

Content

The content domain

Declaration

IContentDomain Content { get; }

Property Value

Type	Description
IContentDomain

| Improve this Doc View Source

Group

The group domain

Declaration

IGroupDomain Group { get; }

Property Value

Type	Description
IGroupDomain

| Improve this Doc View Source

Misc

The misc domain

Declaration

IMiscDomain Misc { get; }

Property Value

Type	Description
IMiscDomain

| Improve this Doc View Source

Plugins

Extensions of the client dock to this property, so typing "confluenceClient.Plugins." should show your extension.

Declaration

IConfluenceClientPlugins Plugins { get; }

Property Value

Type	Description
IConfluenceClientPlugins

| Improve this Doc View Source

Space

The space domain

Declaration

ISpaceDomain Space { get; }

Property Value

Type	Description
ISpaceDomain

| Improve this Doc View Source

User

The user domain

Declaration

IUserDomain User { get; }

Property Value

Type	Description
IUserDomain

Methods

| Improve this Doc View Source

CreateDownloadUri(Links)

Retrieve the Download as Uri from the supplied links object

Declaration

Uri CreateDownloadUri(Links links)

Parameters

Type	Name	Description
Links	links	Links

Returns

Type	Description
Uri	Uri

| Improve this Doc View Source

CreateTinyUiUri(Links)

Retrieve the TinyUi as Uri from the supplied links object

Declaration

Uri CreateTinyUiUri(Links links)

Parameters

Type	Name	Description
Links	links	Links

Returns

Type	Description
Uri	Uri

| Improve this Doc View Source

CreateWebUiUri(Links)

Retrieve the WebUi as Uri from the supplied links object

Declaration

Uri CreateWebUiUri(Links links)

Parameters

Type	Name	Description
Links	links	Links

Returns

Type	Description
Uri	Uri

| Improve this Doc View Source

IsCloudServer(CancellationToken)

Declaration

Task<bool> IsCloudServer(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<System.Boolean>	bool

| Improve this Doc View Source

SetBasicAuthentication(String, String)

Enables basic authentication for every request following this call

Declaration

void SetBasicAuthentication(string user, string password)

Parameters

Type	Name	Description
System.String	user	string with the confluence user
System.String	password	string with the password for the confluence user

| Improve this Doc View Source

SetBearerAuthentication(String)

Enables bearer authentication for every request following this call

Declaration

void SetBearerAuthentication(string bearer)

Parameters

Type	Name	Description
System.String	bearer	string with the bearer (personal access token) for the confluence user