Skip to main content

ConfluenceApi

Struct ConfluenceApi 

Source
pub struct ConfluenceApi { /* private fields */ }
Expand description

Confluence Cloud REST API v2 backend.

Implementations§

Source§

impl ConfluenceApi

Source

pub fn new(client: AtlassianClient) -> Self

Creates a new Confluence API backend.

Source§

impl ConfluenceApi

Source

pub async fn resolve_space_id(&self, space_key: &str) -> Result<String>

Resolves a space key to a space ID via the Confluence API.

Source

pub async fn create_page( &self, space_key: &str, title: &str, body_adf: &AdfDocument, parent_id: Option<&str>, ) -> Result<String>

Creates a new Confluence page.

Source

pub async fn delete_page(&self, id: &str, purge: bool) -> Result<()>

Deletes a Confluence page.

Source

pub async fn get_children(&self, page_id: &str) -> Result<Vec<ChildPage>>

Fetches all child pages of a given page, handling pagination.

Uses the v1 content API (/wiki/rest/api/content/{id}/child/page) which is more widely supported than the v2 children endpoint.

Source

pub async fn get_space_root_pages( &self, space_id: &str, ) -> Result<Vec<ChildPage>>

Fetches top-level pages in a space (pages with no parent), handling pagination.

Uses the v2 API endpoint /wiki/api/v2/spaces/{space-id}/pages?depth=root.

Source

pub async fn get_page_comments( &self, page_id: &str, ) -> Result<Vec<ConfluenceComment>>

Lists footer comments on a Confluence page, handling pagination.

Source

pub async fn add_page_comment( &self, page_id: &str, body_adf: &AdfDocument, ) -> Result<()>

Adds a footer comment to a Confluence page.

Source

pub async fn get_labels(&self, page_id: &str) -> Result<Vec<ConfluenceLabel>>

Fetches all labels on a Confluence page, handling pagination.

Source

pub async fn add_labels(&self, page_id: &str, labels: &[String]) -> Result<()>

Adds one or more labels to a Confluence page.

Source

pub async fn remove_label(&self, page_id: &str, label_name: &str) -> Result<()>

Removes a label from a Confluence page.

Trait Implementations§

Source§

impl AtlassianApi for ConfluenceApi

Source§

fn get_content<'a>( &'a self, id: &'a str, ) -> Pin<Box<dyn Future<Output = Result<ContentItem>> + Send + 'a>>

Fetches a content item by its identifier.
Source§

fn update_content<'a>( &'a self, id: &'a str, body_adf: &'a AdfDocument, title: Option<&'a str>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'a>>

Updates a content item’s body and optionally its title.
Source§

fn verify_auth<'a>( &'a self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'a>>

Verifies authentication and returns a display name.
Source§

fn backend_name(&self) -> &'static str

Returns the backend type name (“jira” or “confluence”).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more