TfvcRestClient class
Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS
- Rozszerzenie
Konstruktory
| Tfvc |
Właściwości
| RESOURCE_AREA_ID |
Metody
| create |
Utwórz nową grupę zmian. |
| get |
Zwraca zestawy zmian dla danej listy identyfikatorów grup zmian. |
| get |
Pobierz pojedynczą hierarchię gałęzi w danej ścieżce z rodzicami lub elementami podrzędnymi zgodnie z określeniem. |
| get |
Pobierz kolekcję korzeni gałęzi — gałęzi pierwszego poziomu, gałęzi bez elementów nadrzędnych. |
| get |
Pobieranie hierarchii gałęzi poniżej określonego scopePath |
| get |
Pobieranie grupy zmian Tfvc |
| get |
Pobieranie zmian Tfvc dla danego zestawu zmian. |
| get |
Pobieranie zestawów zmian Tfvc |
| get |
Pobiera elementy robocze skojarzone z określonym zestawem zmian. |
| get |
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. |
| get |
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. |
| get |
Pobierz listę elementów Tfvc |
| get |
Post do pobierania zestawu elementów z listą ścieżek lub długą ścieżką. Umożliwia określenie deskryptorów recursionLevel i version dla każdej ścieżki. |
| get |
Post do pobierania zestawu elementów z listą ścieżek lub długą ścieżką. Umożliwia określenie deskryptorów recursionLevel i version dla każdej ścieżki. |
| get |
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. |
| get |
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. |
| get |
Korzystaj z jednej etykiety szczegółowej. |
| get |
Pobieranie elementów z etykietą. |
| get |
Pobierz kolekcję płytkich odwołań do etykiet. |
| get |
Zdobądź pojedynczy głęboki zestaw półek. |
| get |
Pobieranie zmian uwzględnionych w zestawie odłożonym. |
| get |
Zwraca kolekcję płytkich odwołań do zestawu odłożonego. |
| get |
Pobierz elementy robocze skojarzone z zestawem odłożonym. |
| get |
Udostępnia liczbę plików i nieskompresowane bajty dla kolekcji/projektu w określonym zakresie dla TFVC. |
Szczegóły konstruktora
TfvcRestClient(IVssRestClientOptions)
Szczegóły właściwości
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringWartość właściwości
string
Szczegóły metody
createChangeset(TfvcChangeset, string)
Utwórz nową grupę 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 grup zmian.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parametry
- changesetsRequestData
- TfvcChangesetsRequestData
Lista identyfikatorów grup zmian.
Zwraca
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Pobierz pojedynczą hierarchię gałęzi w danej ścieżce z rodzicami lub elementami podrzędnymi zgodnie z określeniem.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parametry
- path
-
string
Pełna ścieżka do gałęzi. Domyślnie: $/ Przykłady: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Identyfikator projektu lub nazwa projektu
- includeParent
-
boolean
Zwróć gałąź nadrzędną, jeśli istnieje. Domyślnie: Fałsz
- includeChildren
-
boolean
Zwróć gałęzie podrzędne, jeśli takie istnieją. Domyślnie: Fałsz
Zwraca
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Pobierz kolekcję korzeni gałęzi — gałęzi pierwszego poziomu, gałęzi bez elementów nadrzędnych.
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. Domyślnie: Fałsz
- includeChildren
-
boolean
Zwróć gałęzie podrzędne dla każdej gałęzi głównej. Domyślnie: Fałsz
- includeDeleted
-
boolean
Zwróć usunięte gałęzie. Domyślnie: Fałsz
- includeLinks
-
boolean
Linki zwrotne. Domyślnie: Fałsz
Zwraca
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Pobieranie hierarchii gałęzi poniżej określonego scopePath
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parametry
- scopePath
-
string
Pełna ścieżka do gałęzi. Domyślnie: $/ Przykłady: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Identyfikator projektu lub nazwa projektu
- includeDeleted
-
boolean
Zwróć usunięte gałęzie. Domyślnie: Fałsz
- includeLinks
-
boolean
Linki zwrotne. Domyślnie: Fałsz
Zwraca
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Pobieranie grupy zmian 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 do zwrócenia (maksymalnie 100 zmian) Domyślnie: 0
- includeDetails
-
boolean
W odpowiedzi dołącz szczegółowe informacje o zasadach i uwagi dotyczące zameldowania. Domyślnie: false
- includeWorkItems
-
boolean
Uwzględnij elementy robocze. Domyślnie: false
- maxCommentLength
-
number
Uwzględnij szczegółowe informacje o skojarzonych elementach roboczych w odpowiedzi. Domyślnie: null
- includeSourceRename
-
boolean
Uwzględnij zmiany nazw. Domyślnie: false
- skip
-
number
Liczba wyników do pominięcia. Domyślnie: null
- top
-
number
Maksymalna liczba wyników do zwrócenia. Domyślnie: null
- orderby
-
string
Wyniki są domyślnie sortowane według identyfikatora w kolejności malejącej. Użyj id asc, aby posortować 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) Wartość domyślna: null
Zwraca
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Pobieranie zmian Tfvc dla danego zestawu zmian.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parametry
- id
-
number
Identyfikator grupy zmian. Domyślnie: null
- skip
-
number
Liczba wyników do pominięcia. Domyślnie: null
- top
-
number
Maksymalna liczba wyników do zwrócenia. Domyślnie: 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
Uwzględnij szczegółowe informacje o skojarzonych elementach roboczych w odpowiedzi. Domyślnie: null
- skip
-
number
Liczba wyników do pominięcia. Domyślnie: null
- top
-
number
Maksymalna liczba wyników do zwrócenia. Domyślnie: null
- orderby
-
string
Wyniki są domyślnie sortowane według identyfikatora w kolejności malejącej. Użyj id asc, aby posortować 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) Wartość domyślna: 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 grupy 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
Nazwa pliku zwracanego 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 pliku 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
Nazwa pliku zwracanego 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 pliku json. Wartość domyślna to „false”.
Zwraca
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Pobierz listę elementów 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 do uwzględnienia łączy.
- versionDescriptor
- TfvcVersionDescriptor
Zwraca
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Post do pobierania zestawu elementów z listą ścieżek lub długą ścieżką. Umożliwia określenie deskryptorów recursionLevel i version 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)
Post do pobierania zestawu elementów z listą ścieżek lub długą ścieżką. Umożliwia określenie deskryptorów recursionLevel i version 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
Nazwa pliku zwracanego 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 pliku 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
Nazwa pliku zwracanego 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 pliku json. Wartość domyślna to „false”.
Zwraca
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Korzystaj z jednej etykiety szczegółowej.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parametry
- labelId
-
string
Niepowtarzalny identyfikator etykiety
- requestData
- TfvcLabelRequestData
maxItemCount (liczba)
- project
-
string
Identyfikator projektu lub nazwa projektu
Zwraca
Promise<TfvcLabel>
getLabelItems(string, number, number)
Pobieranie elementów z etykietą.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parametry
- labelId
-
string
Niepowtarzalny identyfikator etykiety
- top
-
number
Maksymalna liczba przedmiotów do zwrotu
- 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, domyślnie 100, gdy nie jest zdefiniowana
- skip
-
number
Liczba etykiet do pominięcia
Zwraca
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Zdobądź pojedynczy głęboki zestaw półek.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parametry
- shelvesetId
-
string
Unikalny identyfikator Shelveset
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount i maxCommentLength
Zwraca
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Pobieranie zmian uwzględnionych w zestawie odłożonym.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parametry
- shelvesetId
-
string
Unikalny identyfikator Shelveset
- top
-
number
Maksymalna liczba zmian do zwrócenia
- skip
-
number
Liczba zmian do pominięcia
Zwraca
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Zwraca kolekcję płytkich odwołań do zestawu odłożonego.
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 zwrotu
- skip
-
number
Liczba zestawów półek do pominięcia
Zwraca
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Pobierz elementy robocze skojarzone z zestawem odłożonym.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parametry
- shelvesetId
-
string
Unikalny identyfikator Shelveset
Zwraca
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Udostępnia liczbę plików i nieskompresowane bajty dla kolekcji/projektu w określonym zakresie dla TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parametry
- project
-
string
Identyfikator projektu lub nazwa projektu
- scopePath
-
string
'$/' dla kolekcji, '$/project' dla konkretnego projektu
Zwraca
Promise<TfvcStatistics>