Struct octocrab::teams::TeamHandler

pub struct TeamHandler<'octo> { /* private fields */ }

Handler for GitHub’s teams API.

Created with Octocrab::teams.

Implementations

impl<'octo> TeamHandler<'octo>

pub fn list(&self) -> ListTeamsBuilder<'_, '_>

Lists teams in the organization.

let teams = octocrab::instance()
    .teams("owner")
    .list()
    .per_page(10)
    .page(1u8)
    .send()
    .await?;

pub async fn get(&self, team_slug: impl Into<String>) -> Result<Team>

Gets a team from its slug.

let team = octocrab::instance()
    .teams("owner")
    .get("team")
    .await?;

pub fn create( &self, name: impl Into<String> ) -> CreateTeamBuilder<'_, '_, '_, '_>

Creates a new team in the organization.

use octocrab::params;

octocrab::instance()
    .teams("owner")
    .create("new-team")
    .description("My team created from Octocrab!")
    .maintainers(&vec![String::from("ferris")])
    .repo_names(&vec![String::from("crab-stuff")])
    .privacy(params::teams::Privacy::Closed)
    .parent_team_id(1u64.into())
    .send()
    .await?;

pub fn edit( &self, team_slug: impl Into<String>, name: impl Into<String> ) -> EditTeamBuilder<'_, '_>

Creates a new team in the organization.

use octocrab::params;

octocrab::instance()
    .teams("owner")
    .edit("some-team", "Some Team")
    .description("I edited from Octocrab!")
    .privacy(params::teams::Privacy::Secret)
    .parent_team_id(2u64.into())
    .send()
    .await?;

pub async fn delete(&self, team_slug: impl Into<String>) -> Result<()>

Deletes a team from the organization.

octocrab::instance().teams("owner").delete("some-team").await?;

pub fn list_children( &self, team_slug: impl Into<String> ) -> ListChildTeamsBuilder<'_, '_>

List the child teams of a team in the organization.

octocrab::instance()
    .teams("owner")
    .list_children("parent-team")
    .per_page(5)
    .page(1u8)
    .send()
    .await?;

pub fn repos(&self, team_slug: impl Into<String>) -> TeamRepoHandler<'_>

Creates a new TeamRepoHandler for the specified team, that allows you to manage this team’s repositories.

pub fn members( &self, team_slug: impl Into<String> ) -> ListTeamMembersBuilder<'_, '_>

List the members of a team in the organization.

octocrab::instance()
    .teams("owner")
    .members("team-name-here")
    .per_page(5)
    .page(1u8)
    .send()
    .await?;

pub fn invitations( &self, team_slug: impl Into<String> ) -> ListTeamInvitationsBuilder<'_, '_>

List the pending invitations for a team in an organization.

octocrab::instance()
    .teams("owner")
    .invitations("team-name-here")
    .per_page(5)
    .page(1u8)
    .send()
    .await?;