ProjectAnalysisRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

ProjectAnalysisRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

getGitRepositoriesActivityMetrics(string, Date, AggregationType, number, number)	Извлекает метрики действий Git для репозиториев, соответствующих указанному критерию.
getProjectActivityMetrics(string, Date, AggregationType)
getProjectLanguageAnalytics(string)
getRepositoryActivityMetrics(string, string, Date, AggregationType)

Сведения о конструкторе

ProjectAnalysisRestClient(IVssRestClientOptions)

new ProjectAnalysisRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

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

Извлекает метрики действий Git для репозиториев, соответствующих указанному критерию.

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

Параметры

project

string

Идентификатор проекта или имя проекта

fromDate

Date

Дата, с которой необходимо получить тенденции.

aggregationType

AggregationType

Размер контейнера, для которого необходимо агрегировать тенденции.

skip

number

Количество репозиториев, которые следует игнорировать.

top

number

Количество репозиториев, для которых необходимо извлечь метрики действий.

Возвращаемое значение

Promise<RepositoryActivityMetrics[]>

getProjectActivityMetrics(string, Date, AggregationType)

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

Параметры

project

string

Идентификатор проекта или имя проекта

fromDate

Date

aggregationType

AggregationType

Возвращаемое значение

Promise<ProjectActivityMetrics>

getProjectLanguageAnalytics(string)

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ProjectLanguageAnalytics>

getRepositoryActivityMetrics(string, string, Date, AggregationType)

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

Параметры

project

string

Идентификатор проекта или имя проекта

repositoryId

string

fromDate

Date

aggregationType

AggregationType

Возвращаемое значение

Promise<RepositoryActivityMetrics>