Skip to main content

ActivityClient

Struct ActivityClient 

Source
pub struct ActivityClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }
Expand description

Client for interacting with Nextcloud’s Activity API v2.

Wraps an OcsClient by reference and provides high-level typed calls for:

  • Listing activities matching filter criteria (/ocs/v2.php/apps/activity/api/v2/activity)
  • Querying activities for a specific object type and ID

See the Nextcloud Activity API documentation and developer_manual source.

Implementations§

Source§

impl<'a, T: Transport, A: AuthProvider> ActivityClient<'a, T, A>

Source

pub const fn new(ocs: &'a OcsClient<T, A>) -> Self

Binds an activity client to an underlying OcsClient.

Source

pub const fn ocs(&self) -> &'a OcsClient<T, A>

Borrows the underlying OcsClient.

Source

pub async fn list( &self, filter: &ActivityFilter, ) -> Result<Vec<Activity>, Error>

Lists activities matching the provided ActivityFilter.

Sends GET /ocs/v2.php/apps/activity/api/v2/activity with query parameters.

See Endpoints and Parameters.

Source

pub async fn list_for_object( &self, object_type: &str, object_id: u64, ) -> Result<Vec<Activity>, Error>

Lists activities related to a specific object type and object ID.

Helper that constructs an ActivityFilter with object_type and object_id and invokes Self::list.

Sends GET /ocs/v2.php/apps/activity/api/v2/activity?format=json&object_type=...&object_id=....

See Parameters.

Trait Implementations§

Source§

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for ActivityClient<'a, T, A>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Copy + Transport, A: Copy + AuthProvider> Copy for ActivityClient<'a, T, A>

Source§

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for ActivityClient<'a, T, A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T, A> Freeze for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: Freeze,

§

impl<'a, T, A> RefUnwindSafe for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: RefUnwindSafe,

§

impl<'a, T, A> Send for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: Send,

§

impl<'a, T, A> Sync for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: Sync,

§

impl<'a, T, A> Unpin for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: Unpin,

§

impl<'a, T, A> UnsafeUnpin for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: UnsafeUnpin,

§

impl<'a, T, A> UnwindSafe for ActivityClient<'a, T, A>
where &'a OcsClient<T, A>: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.