TfvcRestClient class
Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna
- Extends
Konstruktorer
| Tfvc |
Egenskaper
| RESOURCE_AREA_ID |
Metoder
| create |
Skapa en ny ändringsuppsättning. |
| get |
Returnerar ändringsuppsättningar för en viss lista med ändringsuppsättnings-ID:t. |
| get |
Hämta en enda grenhierarki på den angivna sökvägen med överordnade eller underordnade objekt enligt vad som anges. |
| get |
Skaffa en samling grenrötter – barn på första nivån, grenar utan föräldrar. |
| get |
Hämta grenhierarkier under angiven scopePath |
| get |
Hämta en Tfvc-ändringsuppsättning |
| get |
Hämta Tfvc-ändringar för en viss ändringsuppsättning. |
| get |
Hämta Tfvc-ändringsuppsättningar |
| get |
Hämtar de arbetsobjekt som är associerade med en viss ändringsuppsättning. |
| get |
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning. |
| get |
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning. |
| get |
Hämta en lista över Tfvc-objekt |
| get |
Publicera för att hämta en uppsättning objekt med en lista över sökvägar eller en lång sökväg. Gör att du kan ange rekursionLevel och versionsbeskrivningar för varje sökväg. |
| get |
Publicera för att hämta en uppsättning objekt med en lista över sökvägar eller en lång sökväg. Gör att du kan ange rekursionLevel och versionsbeskrivningar för varje sökväg. |
| get |
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning. |
| get |
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning. |
| get |
Hämta en enda djup etikett. |
| get |
Hämta objekt under en etikett. |
| get |
Hämta en samling med ytliga etikettreferenser. |
| get |
Få en enda djup hyllor. |
| get |
Få ändringar som ingår i en hyllor. |
| get |
Returnera en samling ytliga hylloruppsättningsreferenser. |
| get |
Hämta arbetsobjekt som är associerade med en hyllor. |
| get |
Innehåller filantal och okomprimerade byte för en samling/ett projekt i ett visst omfång för TFVC. |
Konstruktorinformation
TfvcRestClient(IVssRestClientOptions)
Egenskapsinformation
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEgenskapsvärde
string
Metodinformation
createChangeset(TfvcChangeset, string)
Skapa en ny ändringsuppsättning.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>Parametrar
- changeset
- TfvcChangeset
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
Returnerar ändringsuppsättningar för en viss lista med ändringsuppsättnings-ID:t.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>Parametrar
- changesetsRequestData
- TfvcChangesetsRequestData
Lista över ändringsuppsättnings-ID:t.
Returer
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
Hämta en enda grenhierarki på den angivna sökvägen med överordnade eller underordnade objekt enligt vad som anges.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>Parametrar
- path
-
string
Fullständig sökväg till -grenen. Standard: $/ Exempel: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID eller projektnamn
- includeParent
-
boolean
Returnera den överordnade grenen om det finns en. Standard: Falskt
- includeChildren
-
boolean
Returnera underordnade grenar, om det finns några. Standard: Falskt
Returer
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
Skaffa en samling grenrötter – barn på första nivån, grenar utan föräldrar.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- includeParent
-
boolean
Returnera den överordnade grenen om det finns en. Standard: Falskt
- includeChildren
-
boolean
Returnera de underordnade grenarna för varje rotgren. Standard: Falskt
- includeDeleted
-
boolean
Returnera borttagna grenar. Standard: Falskt
- includeLinks
-
boolean
Returnera länkar. Standard: Falskt
Returer
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
Hämta grenhierarkier under angiven scopePath
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>Parametrar
- scopePath
-
string
Fullständig sökväg till -grenen. Standard: $/ Exempel: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
Projekt-ID eller projektnamn
- includeDeleted
-
boolean
Returnera borttagna grenar. Standard: Falskt
- includeLinks
-
boolean
Returnera länkar. Standard: Falskt
Returer
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
Hämta en Tfvc-ändringsuppsättning
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>Parametrar
- id
-
number
Ändringsuppsättnings-ID som ska hämtas.
- project
-
string
Projekt-ID eller projektnamn
- maxChangeCount
-
number
Antal ändringar som ska returneras (högst 100 ändringar) Standard: 0
- includeDetails
-
boolean
Inkludera principinformation och incheckningsanteckningar i svaret. Standard: false
- includeWorkItems
-
boolean
Inkludera arbetsobjekt. Standard: false
- maxCommentLength
-
number
Inkludera information om associerade arbetsobjekt i svaret. Standard: null
- includeSourceRename
-
boolean
Ta med namnbyten. Standard: false
- skip
-
number
Antal resultat att hoppa över. Standard: null
- top
-
number
Det maximala antalet resultat som ska returneras. Standard: null
- orderby
-
string
Resultatet sorteras efter ID i fallande ordning som standard. Använd id asc för att sortera efter ID i stigande ordning.
- searchCriteria
- TfvcChangesetSearchCriteria
Följande kriterier är tillgängliga (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standard: null
Returer
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
Hämta Tfvc-ändringar för en viss ändringsuppsättning.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>Parametrar
- id
-
number
ID för ändringsuppsättningen. Standard: null
- skip
-
number
Antal resultat att hoppa över. Standard: null
- top
-
number
Det maximala antalet resultat som ska returneras. Standard: null
Returer
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Hämta Tfvc-ändringsuppsättningar
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- maxCommentLength
-
number
Inkludera information om associerade arbetsobjekt i svaret. Standard: null
- skip
-
number
Antal resultat att hoppa över. Standard: null
- top
-
number
Det maximala antalet resultat som ska returneras. Standard: null
- orderby
-
string
Resultatet sorteras efter ID i fallande ordning som standard. Använd id asc för att sortera efter ID i stigande ordning.
- searchCriteria
- TfvcChangesetSearchCriteria
Följande kriterier är tillgängliga (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Standard: null
Returer
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
Hämtar de arbetsobjekt som är associerade med en viss ändringsuppsättning.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>Parametrar
- id
-
number
ID för ändringsuppsättningen.
Returer
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>Parametrar
- path
-
string
Sökvägen till versionskontroll för ett enskilt objekt som ska returneras.
- project
-
string
Projekt-ID eller projektnamn
- fileName
-
string
filnamnet på objektet som returneras.
- download
-
boolean
Om det är sant skapar du en nedladdningsbar bifogad fil.
- scopePath
-
string
Sökvägen till versionskontroll för en mapp för att returnera flera objekt.
- recursionLevel
- VersionControlRecursionType
Ingen (bara objektet) eller OneLevel (innehållet i en mapp).
- versionDescriptor
- TfvcVersionDescriptor
Versionsbeskrivning. Standardvärdet är null.
- includeContent
-
boolean
Ange till true för att inkludera objektinnehåll när json begärs. Standardvärdet är false.
Returer
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametrar
- path
-
string
Sökvägen till versionskontroll för ett enskilt objekt som ska returneras.
- project
-
string
Projekt-ID eller projektnamn
- fileName
-
string
filnamnet på objektet som returneras.
- download
-
boolean
Om det är sant skapar du en nedladdningsbar bifogad fil.
- scopePath
-
string
Sökvägen till versionskontroll för en mapp för att returnera flera objekt.
- recursionLevel
- VersionControlRecursionType
Ingen (bara objektet) eller OneLevel (innehållet i en mapp).
- versionDescriptor
- TfvcVersionDescriptor
Versionsbeskrivning. Standardvärdet är null.
- includeContent
-
boolean
Ange till true för att inkludera objektinnehåll när json begärs. Standardvärdet är false.
Returer
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Hämta en lista över Tfvc-objekt
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- scopePath
-
string
Sökvägen till versionskontroll för en mapp för att returnera flera objekt.
- recursionLevel
- VersionControlRecursionType
Ingen (bara objektet) eller OneLevel (innehållet i en mapp).
- includeLinks
-
boolean
Sant för att inkludera länkar.
- versionDescriptor
- TfvcVersionDescriptor
Returer
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
Publicera för att hämta en uppsättning objekt med en lista över sökvägar eller en lång sökväg. Gör att du kan ange rekursionLevel och versionsbeskrivningar för varje sökväg.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>Parametrar
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
Publicera för att hämta en uppsättning objekt med en lista över sökvägar eller en lång sökväg. Gör att du kan ange rekursionLevel och versionsbeskrivningar för varje sökväg.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>Parametrar
- itemRequestData
- TfvcItemRequestData
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>Parametrar
- path
-
string
Sökvägen till versionskontroll för ett enskilt objekt som ska returneras.
- project
-
string
Projekt-ID eller projektnamn
- fileName
-
string
filnamnet på objektet som returneras.
- download
-
boolean
Om det är sant skapar du en nedladdningsbar bifogad fil.
- scopePath
-
string
Sökvägen till versionskontroll för en mapp för att returnera flera objekt.
- recursionLevel
- VersionControlRecursionType
Ingen (bara objektet) eller OneLevel (innehållet i en mapp).
- versionDescriptor
- TfvcVersionDescriptor
Versionsbeskrivning. Standardvärdet är null.
- includeContent
-
boolean
Ange till true för att inkludera objektinnehåll när json begärs. Standardvärdet är false.
Returer
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
Hämta objektmetadata och/eller innehåll för ett enskilt objekt. Nedladdningsparametern är för att ange om innehållet ska vara tillgängligt som en nedladdning eller bara skickas som en ström i svaret. Gäller inte för zippat innehåll som alltid returneras som en nedladdning.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametrar
- path
-
string
Sökvägen till versionskontroll för ett enskilt objekt som ska returneras.
- project
-
string
Projekt-ID eller projektnamn
- fileName
-
string
filnamnet på objektet som returneras.
- download
-
boolean
Om det är sant skapar du en nedladdningsbar bifogad fil.
- scopePath
-
string
Sökvägen till versionskontroll för en mapp för att returnera flera objekt.
- recursionLevel
- VersionControlRecursionType
Ingen (bara objektet) eller OneLevel (innehållet i en mapp).
- versionDescriptor
- TfvcVersionDescriptor
Versionsbeskrivning. Standardvärdet är null.
- includeContent
-
boolean
Ange till true för att inkludera objektinnehåll när json begärs. Standardvärdet är false.
Returer
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
Hämta en enda djup etikett.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>Parametrar
- labelId
-
string
Unik identifierare för etikett
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
Projekt-ID eller projektnamn
Returer
Promise<TfvcLabel>
getLabelItems(string, number, number)
Hämta objekt under en etikett.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>Parametrar
- labelId
-
string
Unik identifierare för etikett
- top
-
number
Maximalt antal objekt som ska returneras
- skip
-
number
Antal objekt att hoppa över
Returer
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
Hämta en samling med ytliga etikettreferenser.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>Parametrar
- requestData
- TfvcLabelRequestData
labelScope, namn, ägare och itemLabelFilter
- project
-
string
Projekt-ID eller projektnamn
- top
-
number
Maximalt antal etiketter som ska returneras, standardvärdet är 100 när de är odefinierade
- skip
-
number
Antal etiketter att hoppa över
Returer
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
Få en enda djup hyllor.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>Parametrar
- shelvesetId
-
string
Shelvesets unika ID
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount och maxCommentLength
Returer
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
Få ändringar som ingår i en hyllor.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>Parametrar
- shelvesetId
-
string
Shelvesets unika ID
- top
-
number
Maximalt antal ändringar som ska returneras
- skip
-
number
Antal ändringar att hoppa över
Returer
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
Returnera en samling ytliga hylloruppsättningsreferenser.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>Parametrar
- requestData
- TfvcShelvesetRequestData
name, owner och maxCommentLength
- top
-
number
Maximalt antal hyllor som ska returneras
- skip
-
number
Antal hyllor att hoppa över
Returer
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
Hämta arbetsobjekt som är associerade med en hyllor.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>Parametrar
- shelvesetId
-
string
Shelvesets unika ID
Returer
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
Innehåller filantal och okomprimerade byte för en samling/ett projekt i ett visst omfång för TFVC.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>Parametrar
- project
-
string
Projekt-ID eller projektnamn
- scopePath
-
string
$/för samling, $/project för ett visst projekt
Returer
Promise<TfvcStatistics>