Compartilhar via

ProjectAnalysisRestClient class

  • Referência
Pacote:
azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends
RestClientBase

Construtores

ProjectAnalysisRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

getGitRepositoriesActivityMetrics(string, Date, AggregationType, number, number)

Recupera as métricas de atividade git para repositórios que correspondem a um critério especificado.
getProjectActivityMetrics(string, Date, AggregationType)
getProjectLanguageAnalytics(string)
getRepositoryActivityMetrics(string, string, Date, AggregationType)

Detalhes do construtor

ProjectAnalysisRestClient(IVssRestClientOptions) 

new ProjectAnalysisRestClient(options: IVssRestClientOptions)

Parâmetros

options
IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID 

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

getGitRepositoriesActivityMetrics(string, Date, AggregationType, number, number)

Recupera as métricas de atividade git para repositórios que correspondem a um critério especificado.

function getGitRepositoriesActivityMetrics(project: string, fromDate: Date, aggregationType: AggregationType, skip: number, top: number): Promise<RepositoryActivityMetrics[]>

Parâmetros

project

string

ID do projeto ou nome do projeto

fromDate

Date

Data da qual as tendências devem ser buscadas.

aggregationType
AggregationType

Tamanho do bucket no qual as tendências devem ser agregadas.

skip

number

O número de repositórios a serem ignorados.

top

number

O número de repositórios para os quais as métricas de atividade devem ser recuperadas.

Retornos

Promise<RepositoryActivityMetrics[]>

getProjectActivityMetrics(string, Date, AggregationType) 

function getProjectActivityMetrics(project: string, fromDate: Date, aggregationType: AggregationType): Promise<ProjectActivityMetrics>

Parâmetros

project

string

ID do projeto ou nome do projeto

fromDate

Date

aggregationType
AggregationType

Retornos

Promise<ProjectActivityMetrics>

getProjectLanguageAnalytics(string) 

function getProjectLanguageAnalytics(project: string): Promise<ProjectLanguageAnalytics>

Parâmetros

project

string

ID do projeto ou nome do projeto

Retornos

Promise<ProjectLanguageAnalytics>

getRepositoryActivityMetrics(string, string, Date, AggregationType) 

function getRepositoryActivityMetrics(project: string, repositoryId: string, fromDate: Date, aggregationType: AggregationType): Promise<RepositoryActivityMetrics>

Parâmetros

project

string

ID do projeto ou nome do projeto

repositoryId

string

fromDate

Date

aggregationType
AggregationType

Retornos

Promise<RepositoryActivityMetrics>