TfvcRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

TfvcRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createChangeset(TfvcChangeset, string)	Utwórz nowy zestaw zmian.
getBatchedChangesets(TfvcChangesetsRequestData)	Zwraca zestawy zmian dla danej listy identyfikatorów zestawu zmian.
getBranch(string, string, boolean, boolean)	Pobierz pojedynczą hierarchię gałęzi w danej ścieżce z elementami nadrzędnymi lub elementami podrzędnymi określonymi.
getBranches(string, boolean, boolean, boolean, boolean)	Pobierz kolekcję korzeni gałęzi - dzieci pierwszego poziomu, gałęzie bez rodziców.
getBranchRefs(string, string, boolean, boolean)	Pobieranie hierarchii gałęzi poniżej określonego parametru scopePath
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)	Pobieranie zestawu zmian serwera Tfvc
getChangesetChanges(number, number, number)	Pobierz zmiany serwera Tfvc dla danego zestawu zmian.
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)	Pobieranie zestawów zmian tfvc
getChangesetWorkItems(number)	Pobiera elementy robocze skojarzone z określonym zestawem zmian.
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)	Pobieranie listy elementów serwera Tfvc
getItemsBatch(TfvcItemRequestData, string)	Opublikuj na potrzeby pobierania zestawu elementów z listy ścieżek lub długiej ścieżki. Umożliwia określenie rekursjiLevel i deskryptorów wersji dla każdej ścieżki.
getItemsBatchZip(TfvcItemRequestData, string)	Opublikuj na potrzeby pobierania zestawu elementów z listy ścieżek lub długiej ścieżki. Umożliwia określenie rekursjiLevel i deskryptorów wersji dla każdej ścieżki.
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)	Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.
getLabel(string, TfvcLabelRequestData, string)	Uzyskaj pojedynczą etykietę głęboką.
getLabelItems(string, number, number)	Pobierz elementy pod etykietą.
getLabels(TfvcLabelRequestData, string, number, number)	Pobierz kolekcję płytkich odwołań do etykiet.
getShelveset(string, TfvcShelvesetRequestData)	Uzyskaj pojedynczą głęboką półkę.
getShelvesetChanges(string, number, number)	Pobieranie zmian w zestawie półek.
getShelvesets(TfvcShelvesetRequestData, number, number)	Zwróć kolekcję płytkich odwołań do półek.
getShelvesetWorkItems(string)	Pobieranie elementów roboczych skojarzonych z zestawem półek.
getTfvcStatistics(string, string)	Zapewnia liczbę plików i nieskompresowane bajty dla kolekcji/projektu w określonym zakresie dla serwera TFVC.

Szczegóły konstruktora

TfvcRestClient(IVssRestClientOptions)

new TfvcRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createChangeset(TfvcChangeset, string)

Utwórz nowy zestaw zmian.

function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>

Parametry

changeset

TfvcChangeset

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TfvcChangesetRef>

getBatchedChangesets(TfvcChangesetsRequestData)

Zwraca zestawy zmian dla danej listy identyfikatorów zestawu zmian.

function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>

Parametry

changesetsRequestData

TfvcChangesetsRequestData

Lista identyfikatorów zestawu zmian.

Zwraca

Promise<TfvcChangesetRef[]>

getBranch(string, string, boolean, boolean)

Pobierz pojedynczą hierarchię gałęzi w danej ścieżce z elementami nadrzędnymi lub elementami podrzędnymi określonymi.

function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>

Parametry

path

string

Pełna ścieżka do gałęzi. Wartość domyślna: $/ Przykłady: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Identyfikator projektu lub nazwa projektu

includeParent

boolean

Zwróć gałąź nadrzędną, jeśli istnieje. Ustawienie domyślne: Fałsz

includeChildren

boolean

Zwracaj gałęzie podrzędne, jeśli istnieją. Ustawienie domyślne: Fałsz

Zwraca

Promise<TfvcBranch>

getBranches(string, boolean, boolean, boolean, boolean)

Pobierz kolekcję korzeni gałęzi - dzieci pierwszego poziomu, gałęzie bez rodziców.

function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

includeParent

boolean

Zwróć gałąź nadrzędną, jeśli istnieje. Ustawienie domyślne: Fałsz

includeChildren

boolean

Zwróć gałęzie podrzędne dla każdej gałęzi głównej. Ustawienie domyślne: Fałsz

includeDeleted

boolean

Zwraca usunięte gałęzie. Ustawienie domyślne: Fałsz

includeLinks

boolean

Zwracaj łącza. Ustawienie domyślne: Fałsz

Zwraca

Promise<TfvcBranch[]>

getBranchRefs(string, string, boolean, boolean)

Pobieranie hierarchii gałęzi poniżej określonego parametru scopePath

function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>

Parametry

scopePath

string

Pełna ścieżka do gałęzi. Wartość domyślna: $/ Przykłady: $/, $/MyProject, $/MyProject/SomeFolder.

project

string

Identyfikator projektu lub nazwa projektu

includeDeleted

boolean

Zwraca usunięte gałęzie. Ustawienie domyślne: Fałsz

includeLinks

boolean

Zwracaj łącza. Ustawienie domyślne: Fałsz

Zwraca

Promise<TfvcBranchRef[]>

getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)

Pobieranie zestawu zmian serwera Tfvc

function getChangeset(id: number, project?: string, maxChangeCount?: number, includeDetails?: boolean, includeWorkItems?: boolean, maxCommentLength?: number, includeSourceRename?: boolean, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangeset>

Parametry

id

number

Identyfikator zestawu zmian do pobrania.

project

string

Identyfikator projektu lub nazwa projektu

maxChangeCount

number

Liczba zmian zwracanych (maksymalnie 100 zmian) Wartość domyślna: 0

includeDetails

boolean

Dołącz szczegóły zasad i notatki zaewidencjonowania w odpowiedzi. Wartość domyślna: false

includeWorkItems

boolean

Uwzględnij elementy robocze. Wartość domyślna: false

maxCommentLength

number

Dołącz szczegóły dotyczące skojarzonych elementów roboczych w odpowiedzi. Wartość domyślna: null

includeSourceRename

boolean

Uwzględnij zmiany nazw. Wartość domyślna: false

skip

number

Liczba wyników do pominięcia. Wartość domyślna: null

top

number

Maksymalna liczba wyników do zwrócenia. Wartość domyślna: null

orderby

string

Wyniki są sortowane według identyfikatora w kolejności malejącej domyślnie. Użyj identyfikatora asc do sortowania według identyfikatora w kolejności rosnącej.

searchCriteria

TfvcChangesetSearchCriteria

Dostępne są następujące kryteria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

Zwraca

Promise<TfvcChangeset>

getChangesetChanges(number, number, number)

Pobierz zmiany serwera Tfvc dla danego zestawu zmian.

function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>

Parametry

id

number

Identyfikator zestawu zmian. Wartość domyślna: null

skip

number

Liczba wyników do pominięcia. Wartość domyślna: null

top

number

Maksymalna liczba wyników do zwrócenia. Wartość domyślna: null

Zwraca

Promise<PagedList<TfvcChange>>

getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)

Pobieranie zestawów zmian tfvc

function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

maxCommentLength

number

Dołącz szczegóły dotyczące skojarzonych elementów roboczych w odpowiedzi. Wartość domyślna: null

skip

number

Liczba wyników do pominięcia. Wartość domyślna: null

top

number

Maksymalna liczba wyników do zwrócenia. Wartość domyślna: null

orderby

string

Wyniki są sortowane według identyfikatora w kolejności malejącej domyślnie. Użyj identyfikatora asc do sortowania według identyfikatora w kolejności rosnącej.

searchCriteria

TfvcChangesetSearchCriteria

Dostępne są następujące kryteria (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

Zwraca

Promise<TfvcChangesetRef[]>

getChangesetWorkItems(number)

Pobiera elementy robocze skojarzone z określonym zestawem zmian.

function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

Parametry

id

number

Identyfikator zestawu zmian.

Zwraca

Promise<AssociatedWorkItem[]>

getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>

Parametry

path

string

Ścieżka kontroli wersji pojedynczego elementu do zwrócenia.

project

string

Identyfikator projektu lub nazwa projektu

fileName

string

zwrócona nazwa pliku elementu.

download

boolean

Jeśli to prawda, utwórz załącznik do pobrania.

scopePath

string

Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.

recursionLevel

VersionControlRecursionType

Brak (tylko element) lub OneLevel (zawartość folderu).

versionDescriptor

TfvcVersionDescriptor

Deskryptor wersji. Wartość domyślna to null.

includeContent

boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.

Zwraca

Promise<TfvcItem>

getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parametry

path

string

Ścieżka kontroli wersji pojedynczego elementu do zwrócenia.

project

string

Identyfikator projektu lub nazwa projektu

fileName

string

zwrócona nazwa pliku elementu.

download

boolean

Jeśli to prawda, utwórz załącznik do pobrania.

scopePath

string

Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.

recursionLevel

VersionControlRecursionType

Brak (tylko element) lub OneLevel (zawartość folderu).

versionDescriptor

TfvcVersionDescriptor

Deskryptor wersji. Wartość domyślna to null.

includeContent

boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)

Pobieranie listy elementów serwera Tfvc

function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

scopePath

string

Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.

recursionLevel

VersionControlRecursionType

Brak (tylko element) lub OneLevel (zawartość folderu).

includeLinks

boolean

Wartość True, aby dołączyć łącza.

versionDescriptor

TfvcVersionDescriptor

Zwraca

Promise<TfvcItem[]>

getItemsBatch(TfvcItemRequestData, string)

Opublikuj na potrzeby pobierania zestawu elementów z listy ścieżek lub długiej ścieżki. Umożliwia określenie rekursjiLevel i deskryptorów wersji dla każdej ścieżki.

function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>

Parametry

itemRequestData

TfvcItemRequestData

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TfvcItem[][]>

getItemsBatchZip(TfvcItemRequestData, string)

Opublikuj na potrzeby pobierania zestawu elementów z listy ścieżek lub długiej ścieżki. Umożliwia określenie rekursjiLevel i deskryptorów wersji dla każdej ścieżki.

function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>

Parametry

itemRequestData

TfvcItemRequestData

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ArrayBuffer>

getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>

Parametry

path

string

Ścieżka kontroli wersji pojedynczego elementu do zwrócenia.

project

string

Identyfikator projektu lub nazwa projektu

fileName

string

zwrócona nazwa pliku elementu.

download

boolean

Jeśli to prawda, utwórz załącznik do pobrania.

scopePath

string

Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.

recursionLevel

VersionControlRecursionType

Brak (tylko element) lub OneLevel (zawartość folderu).

versionDescriptor

TfvcVersionDescriptor

Deskryptor wersji. Wartość domyślna to null.

includeContent

boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.

Zwraca

Promise<string>

getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)

Pobierz metadane elementu i/lub zawartość dla pojedynczego elementu. Parametr pobierania wskazuje, czy zawartość powinna być dostępna jako pobieranie, czy po prostu wysłana jako strumień w odpowiedzi. Nie ma zastosowania do spakowanej zawartości, która jest zawsze zwracana jako pobieranie.

function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>

Parametry

path

string

Ścieżka kontroli wersji pojedynczego elementu do zwrócenia.

project

string

Identyfikator projektu lub nazwa projektu

fileName

string

zwrócona nazwa pliku elementu.

download

boolean

Jeśli to prawda, utwórz załącznik do pobrania.

scopePath

string

Ścieżka kontroli wersji folderu w celu zwrócenia wielu elementów.

recursionLevel

VersionControlRecursionType

Brak (tylko element) lub OneLevel (zawartość folderu).

versionDescriptor

TfvcVersionDescriptor

Deskryptor wersji. Wartość domyślna to null.

includeContent

boolean

Ustaw wartość true, aby uwzględnić zawartość elementu podczas żądania json. Wartość domyślna to false.

Zwraca

Promise<ArrayBuffer>

getLabel(string, TfvcLabelRequestData, string)

Uzyskaj pojedynczą etykietę głęboką.

function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>

Parametry

labelId

string

Unikatowy identyfikator etykiety

requestData

TfvcLabelRequestData

maxItemCount

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<TfvcLabel>

getLabelItems(string, number, number)

Pobierz elementy pod etykietą.

function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

Parametry

labelId

string

Unikatowy identyfikator etykiety

top

number

Maksymalna liczba elementów do zwrócenia

skip

number

Liczba elementów do pominięcia

Zwraca

Promise<TfvcItem[]>

getLabels(TfvcLabelRequestData, string, number, number)

Pobierz kolekcję płytkich odwołań do etykiet.

function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>

Parametry

requestData

TfvcLabelRequestData

labelScope, name, owner i itemLabelFilter

project

string

Identyfikator projektu lub nazwa projektu

top

number

Maksymalna liczba etykiet do zwrócenia, wartość domyślna to 100, gdy niezdefiniowane

skip

number

Liczba etykiet do pominięcia

Zwraca

Promise<TfvcLabelRef[]>

getShelveset(string, TfvcShelvesetRequestData)

Uzyskaj pojedynczą głęboką półkę.

function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>

Parametry

shelvesetId

string

Unikatowy identyfikator zestawu półek

requestData

TfvcShelvesetRequestData

includeDetails, includeWorkItems, maxChangeCount i maxCommentLength

Zwraca

Promise<TfvcShelveset>

getShelvesetChanges(string, number, number)

Pobieranie zmian w zestawie półek.

function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>

Parametry

shelvesetId

string

Unikatowy identyfikator zestawu półek

top

number

Maksymalna liczba zmian do zwrócenia

skip

number

Liczba zmian do pominięcia

Zwraca

Promise<TfvcChange[]>

getShelvesets(TfvcShelvesetRequestData, number, number)

Zwróć kolekcję płytkich odwołań do półek.

function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>

Parametry

requestData

TfvcShelvesetRequestData

name, owner i maxCommentLength

top

number

Maksymalna liczba zestawów półek do zwrócenia

skip

number

Liczba zestawów półek do pominięcia

Zwraca

Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems(string)

Pobieranie elementów roboczych skojarzonych z zestawem półek.

function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

Parametry

shelvesetId

string

Unikatowy identyfikator zestawu półek

Zwraca

Promise<AssociatedWorkItem[]>

getTfvcStatistics(string, string)

Zapewnia liczbę plików i nieskompresowane bajty dla kolekcji/projektu w określonym zakresie dla serwera TFVC.

function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

scopePath

string

"$/" dla kolekcji "$/project" dla określonego projektu

Zwraca

Promise<TfvcStatistics>