octocrab 0.54.2

A modern, extensible GitHub API client.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Github Activity API

use crate::Octocrab;

pub mod events;
pub mod notifications;
pub mod starring;
pub mod watching;

/// Handler for GitHub's activity API.
///
/// Created with [`Octocrab::activity`].
pub struct ActivityHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> ActivityHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab) -> Self {
        Self { crab }
    }

    /// Creates a `NotificationsHandler` for the current authenticated user.
    pub fn notifications(&self) -> notifications::NotificationsHandler<'octo> {
        notifications::NotificationsHandler::new(self.crab)
    }

    pub fn starring(&self) -> starring::StarringHandler<'octo> {
        starring::StarringHandler::new(self.crab)
    }

    /// Creates a [`WatchingHandler`] for accessing GitHub's watching/subscription API.
    pub fn watching(&self) -> watching::WatchingHandler<'octo> {
        watching::WatchingHandler::new(self.crab)
    }

    /// Creates an [`ActivityEventsHandler`] for accessing GitHub's activity events API.
    pub fn events(&self) -> events::ActivityEventsHandler<'octo> {
        events::ActivityEventsHandler::new(self.crab)
    }

    /// Lists the feeds available to the authenticated user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/feeds?apiVersion=2022-11-28#get-feeds)
    pub async fn feeds(&self) -> crate::Result<crate::models::activity::Feeds> {
        self.crab.get("/feeds", None::<&()>).await
    }
}