Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TeamsApi

Hierarchy

  • TeamsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TeamsApi(basePath?: string): TeamsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createTeam

  • createTeam(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WebApiTeam>

  • Create a team in a team project. Possible failure scenarios Invalid project name/ID (project doesn't exist) 404 Invalid team name or description 400 Team already exists 400 Insufficient privileges 400

    Parameters

    • params: object
      • apiVersion: string
      • body: WebApiTeam
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WebApiTeam>

deleteTeam

  • deleteTeam(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Delete a team.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • projectId: string
      • teamId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getAllTeams

  • getAllTeams(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WebApiTeam>>

  • Get a list of all teams.

    Parameters

    • params: object
      • Optional $Mine?: boolean
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<WebApiTeam>>

getTeam

  • getTeam(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WebApiTeam>

  • Get a specific team.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • projectId: string
      • teamId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WebApiTeam>

getTeamMembersWithExtendedProperties

  • getTeamMembersWithExtendedProperties(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TeamMember>>

  • Get a list of members for a specific team.

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • organization: string
      • projectId: string
      • teamId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<TeamMember>>

getTeams

  • Get a list of teams.

    Parameters

    • params: object
      • Optional $Mine?: boolean
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • organization: string
      • projectId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<WebApiTeam>>

updateTeam

  • updateTeam(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WebApiTeam>

  • Update a team's name and/or description.

    Parameters

    • params: object
      • apiVersion: string
      • body: WebApiTeam
      • organization: string
      • projectId: string
      • teamId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WebApiTeam>

Generated using TypeDoc