TfvcRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Tfvc |
속성
| RESOURCE_AREA_ID |
메서드
생성자 세부 정보
TfvcRestClient(IVssRestClientOptions)
속성 세부 정보
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string속성 값
string
메서드 세부 정보
createChangeset(TfvcChangeset, string)
새 변경 집합을 만듭니다.
function createChangeset(changeset: TfvcChangeset, project?: string): Promise<TfvcChangesetRef>매개 변수
- changeset
- TfvcChangeset
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<TfvcChangesetRef>
getBatchedChangesets(TfvcChangesetsRequestData)
지정된 변경 집합 ID 목록에 대한 변경 집합을 반환합니다.
function getBatchedChangesets(changesetsRequestData: TfvcChangesetsRequestData): Promise<TfvcChangesetRef[]>매개 변수
- changesetsRequestData
- TfvcChangesetsRequestData
변경 집합 ID 목록입니다.
반환
Promise<TfvcChangesetRef[]>
getBranch(string, string, boolean, boolean)
지정된 대로 부모 또는 자식이 있는 지정된 경로에서 단일 분기 계층 구조를 가져옵니다.
function getBranch(path: string, project?: string, includeParent?: boolean, includeChildren?: boolean): Promise<TfvcBranch>매개 변수
- path
-
string
분기의 전체 경로입니다. 기본값: $/ 예제: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- includeParent
-
boolean
부모 분기가 있는 경우 부모 분기를 반환합니다. 기본값: False
- includeChildren
-
boolean
자식 분기(있는 경우)를 반환합니다. 기본값: False
반환
Promise<TfvcBranch>
getBranches(string, boolean, boolean, boolean, boolean)
1급 자식, 부모가 없는 분기와 같은 분기 루트 컬렉션을 가져옵니다.
function getBranches(project?: string, includeParent?: boolean, includeChildren?: boolean, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranch[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- includeParent
-
boolean
부모 분기가 있는 경우 부모 분기를 반환합니다. 기본값: False
- includeChildren
-
boolean
각 루트 분기에 대한 자식 분기를 반환합니다. 기본값: False
- includeDeleted
-
boolean
삭제된 분기를 반환합니다. 기본값: False
- includeLinks
-
boolean
링크를 반환합니다. 기본값: False
반환
Promise<TfvcBranch[]>
getBranchRefs(string, string, boolean, boolean)
지정된 scopePath 아래의 분기 계층을 가져옵니다.
function getBranchRefs(scopePath: string, project?: string, includeDeleted?: boolean, includeLinks?: boolean): Promise<TfvcBranchRef[]>매개 변수
- scopePath
-
string
분기의 전체 경로입니다. 기본값: $/ 예제: $/, $/MyProject, $/MyProject/SomeFolder.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- includeDeleted
-
boolean
삭제된 분기를 반환합니다. 기본값: False
- includeLinks
-
boolean
링크를 반환합니다. 기본값: False
반환
Promise<TfvcBranchRef[]>
getChangeset(number, string, number, boolean, boolean, number, boolean, number, number, string, TfvcChangesetSearchCriteria)
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>매개 변수
- id
-
number
검색할 변경 집합 ID입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- maxChangeCount
-
number
반환할 변경 내용 수(최대 100개 변경) 기본값: 0
- includeDetails
-
boolean
응답에 정책 세부 정보 및 검사 노트를 포함합니다. 기본값: false
- includeWorkItems
-
boolean
작업 영역 포함 기본값: false
- maxCommentLength
-
number
응답에 연결된 작업 항목에 대한 세부 정보를 포함합니다. 기본값: null
- includeSourceRename
-
boolean
이름 바꾸기를 포함합니다. 기본값: false
- skip
-
number
건너뛸 결과 수입니다. 기본값: null
- top
-
number
반환할 결과의 최대 수입니다. 기본값: null
- orderby
-
string
결과는 기본적으로 내림차순으로 ID별로 정렬됩니다. ID asc를 사용하여 ID를 오름차순으로 정렬합니다.
- searchCriteria
- TfvcChangesetSearchCriteria
사용 가능한 조건(.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) 기본값: null
반환
Promise<TfvcChangeset>
getChangesetChanges(number, number, number)
지정된 변경 집합에 대한 Tfvc 변경 내용을 검색합니다.
function getChangesetChanges(id?: number, skip?: number, top?: number): Promise<PagedList<TfvcChange>>매개 변수
- id
-
number
변경 집합의 ID입니다. 기본값: null
- skip
-
number
건너뛸 결과 수입니다. 기본값: null
- top
-
number
반환할 결과의 최대 수입니다. 기본값: null
반환
Promise<PagedList<TfvcChange>>
getChangesets(string, number, number, number, string, TfvcChangesetSearchCriteria)
Tfvc 변경 집합 검색
function getChangesets(project?: string, maxCommentLength?: number, skip?: number, top?: number, orderby?: string, searchCriteria?: TfvcChangesetSearchCriteria): Promise<TfvcChangesetRef[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- maxCommentLength
-
number
응답에 연결된 작업 항목에 대한 세부 정보를 포함합니다. 기본값: null
- skip
-
number
건너뛸 결과 수입니다. 기본값: null
- top
-
number
반환할 결과의 최대 수입니다. 기본값: null
- orderby
-
string
결과는 기본적으로 내림차순으로 ID별로 정렬됩니다. ID asc를 사용하여 ID를 오름차순으로 정렬합니다.
- searchCriteria
- TfvcChangesetSearchCriteria
사용 가능한 조건(.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) 기본값: null
반환
Promise<TfvcChangesetRef[]>
getChangesetWorkItems(number)
특정 변경 집합과 연결된 작업 항목을 검색합니다.
function getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>매개 변수
- id
-
number
변경 집합의 ID입니다.
반환
Promise<AssociatedWorkItem[]>
getItem(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
단일 항목에 대한 항목 메타데이터 및/또는 콘텐츠를 가져옵니다. 다운로드 매개 변수는 콘텐츠를 다운로드로 사용할 수 있는지 아니면 응답에서 스트림으로 전송해야 하는지를 나타내는 것입니다. 항상 다운로드로 반환되는 압축된 콘텐츠에는 적용되지 않습니다.
function getItem(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<TfvcItem>매개 변수
- path
-
string
반환할 개별 항목의 버전 제어 경로입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
반환된 항목의 파일 이름입니다.
- download
-
boolean
true이면 다운로드 가능한 첨부 파일을 만듭니다.
- scopePath
-
string
여러 항목을 반환할 폴더의 버전 제어 경로입니다.
- recursionLevel
- VersionControlRecursionType
None(항목만 해당) 또는 OneLevel(폴더의 내용).
- versionDescriptor
- TfvcVersionDescriptor
버전 설명자입니다. 기본값은 null입니다.
- includeContent
-
boolean
json을 요청할 때 항목 콘텐츠를 포함하려면 true로 설정합니다. 기본값은 false입니다.
반환
Promise<TfvcItem>
getItemContent(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
단일 항목에 대한 항목 메타데이터 및/또는 콘텐츠를 가져옵니다. 다운로드 매개 변수는 콘텐츠를 다운로드로 사용할 수 있는지 아니면 응답에서 스트림으로 전송해야 하는지를 나타내는 것입니다. 항상 다운로드로 반환되는 압축된 콘텐츠에는 적용되지 않습니다.
function getItemContent(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>매개 변수
- path
-
string
반환할 개별 항목의 버전 제어 경로입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
반환된 항목의 파일 이름입니다.
- download
-
boolean
true이면 다운로드 가능한 첨부 파일을 만듭니다.
- scopePath
-
string
여러 항목을 반환할 폴더의 버전 제어 경로입니다.
- recursionLevel
- VersionControlRecursionType
None(항목만 해당) 또는 OneLevel(폴더의 내용).
- versionDescriptor
- TfvcVersionDescriptor
버전 설명자입니다. 기본값은 null입니다.
- includeContent
-
boolean
json을 요청할 때 항목 콘텐츠를 포함하려면 true로 설정합니다. 기본값은 false입니다.
반환
Promise<ArrayBuffer>
getItems(string, string, VersionControlRecursionType, boolean, TfvcVersionDescriptor)
Tfvc 항목 목록 가져오기
function getItems(project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeLinks?: boolean, versionDescriptor?: TfvcVersionDescriptor): Promise<TfvcItem[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- scopePath
-
string
여러 항목을 반환할 폴더의 버전 제어 경로입니다.
- recursionLevel
- VersionControlRecursionType
None(항목만 해당) 또는 OneLevel(폴더의 내용).
- includeLinks
-
boolean
True이면 링크를 포함합니다.
- versionDescriptor
- TfvcVersionDescriptor
반환
Promise<TfvcItem[]>
getItemsBatch(TfvcItemRequestData, string)
경로 목록 또는 긴 경로가 지정된 항목 집합을 검색하기 위한 게시입니다. 각 경로에 대해 recursionLevel 및 버전 설명자를 지정할 수 있습니다.
function getItemsBatch(itemRequestData: TfvcItemRequestData, project?: string): Promise<TfvcItem[][]>매개 변수
- itemRequestData
- TfvcItemRequestData
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<TfvcItem[][]>
getItemsBatchZip(TfvcItemRequestData, string)
경로 목록 또는 긴 경로가 지정된 항목 집합을 검색하기 위한 게시입니다. 각 경로에 대해 recursionLevel 및 버전 설명자를 지정할 수 있습니다.
function getItemsBatchZip(itemRequestData: TfvcItemRequestData, project?: string): Promise<ArrayBuffer>매개 변수
- itemRequestData
- TfvcItemRequestData
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<ArrayBuffer>
getItemText(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
단일 항목에 대한 항목 메타데이터 및/또는 콘텐츠를 가져옵니다. 다운로드 매개 변수는 콘텐츠를 다운로드로 사용할 수 있는지 아니면 응답에서 스트림으로 전송해야 하는지를 나타내는 것입니다. 항상 다운로드로 반환되는 압축된 콘텐츠에는 적용되지 않습니다.
function getItemText(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<string>매개 변수
- path
-
string
반환할 개별 항목의 버전 제어 경로입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
반환된 항목의 파일 이름입니다.
- download
-
boolean
true이면 다운로드 가능한 첨부 파일을 만듭니다.
- scopePath
-
string
여러 항목을 반환할 폴더의 버전 제어 경로입니다.
- recursionLevel
- VersionControlRecursionType
None(항목만 해당) 또는 OneLevel(폴더의 내용).
- versionDescriptor
- TfvcVersionDescriptor
버전 설명자입니다. 기본값은 null입니다.
- includeContent
-
boolean
json을 요청할 때 항목 콘텐츠를 포함하려면 true로 설정합니다. 기본값은 false입니다.
반환
Promise<string>
getItemZip(string, string, string, boolean, string, VersionControlRecursionType, TfvcVersionDescriptor, boolean)
단일 항목에 대한 항목 메타데이터 및/또는 콘텐츠를 가져옵니다. 다운로드 매개 변수는 콘텐츠를 다운로드로 사용할 수 있는지 아니면 응답에서 스트림으로 전송해야 하는지를 나타내는 것입니다. 항상 다운로드로 반환되는 압축된 콘텐츠에는 적용되지 않습니다.
function getItemZip(path: string, project?: string, fileName?: string, download?: boolean, scopePath?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: TfvcVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>매개 변수
- path
-
string
반환할 개별 항목의 버전 제어 경로입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- fileName
-
string
반환된 항목의 파일 이름입니다.
- download
-
boolean
true이면 다운로드 가능한 첨부 파일을 만듭니다.
- scopePath
-
string
여러 항목을 반환할 폴더의 버전 제어 경로입니다.
- recursionLevel
- VersionControlRecursionType
None(항목만 해당) 또는 OneLevel(폴더의 내용).
- versionDescriptor
- TfvcVersionDescriptor
버전 설명자입니다. 기본값은 null입니다.
- includeContent
-
boolean
json을 요청할 때 항목 콘텐츠를 포함하려면 true로 설정합니다. 기본값은 false입니다.
반환
Promise<ArrayBuffer>
getLabel(string, TfvcLabelRequestData, string)
단일 심층 레이블을 가져옵니다.
function getLabel(labelId: string, requestData: TfvcLabelRequestData, project?: string): Promise<TfvcLabel>매개 변수
- labelId
-
string
레이블의 고유 식별자
- requestData
- TfvcLabelRequestData
maxItemCount
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<TfvcLabel>
getLabelItems(string, number, number)
레이블 아래에 항목을 가져옵니다.
function getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>매개 변수
- labelId
-
string
레이블의 고유 식별자
- top
-
number
반환할 최대 항목 수
- skip
-
number
건너뛸 항목 수
반환
Promise<TfvcItem[]>
getLabels(TfvcLabelRequestData, string, number, number)
단순 레이블 참조 컬렉션을 가져옵니다.
function getLabels(requestData: TfvcLabelRequestData, project?: string, top?: number, skip?: number): Promise<TfvcLabelRef[]>매개 변수
- requestData
- TfvcLabelRequestData
labelScope, name, owner 및 itemLabelFilter
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- top
-
number
반환할 최대 레이블 수이며, 정의되지 않은 경우 기본값은 100입니다.
- skip
-
number
건너뛸 레이블 수
반환
Promise<TfvcLabelRef[]>
getShelveset(string, TfvcShelvesetRequestData)
하나의 깊은 선반을 가져옵니다.
function getShelveset(shelvesetId: string, requestData?: TfvcShelvesetRequestData): Promise<TfvcShelveset>매개 변수
- shelvesetId
-
string
진열대 고유 ID
- requestData
- TfvcShelvesetRequestData
includeDetails, includeWorkItems, maxChangeCount 및 maxCommentLength
반환
Promise<TfvcShelveset>
getShelvesetChanges(string, number, number)
선반에 포함된 변경 내용을 가져옵니다.
function getShelvesetChanges(shelvesetId: string, top?: number, skip?: number): Promise<TfvcChange[]>매개 변수
- shelvesetId
-
string
진열대 고유 ID
- top
-
number
반환할 최대 변경 내용 수
- skip
-
number
건너뛸 변경 내용 수
반환
Promise<TfvcChange[]>
getShelvesets(TfvcShelvesetRequestData, number, number)
단순 선반 참조 컬렉션을 반환합니다.
function getShelvesets(requestData?: TfvcShelvesetRequestData, top?: number, skip?: number): Promise<TfvcShelvesetRef[]>매개 변수
- requestData
- TfvcShelvesetRequestData
name, owner 및 maxCommentLength
- top
-
number
반환할 최대 선반 수
- skip
-
number
건너뛸 선반 수
반환
Promise<TfvcShelvesetRef[]>
getShelvesetWorkItems(string)
선반과 연결된 작업 항목을 가져옵니다.
function getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>매개 변수
- shelvesetId
-
string
진열대 고유 ID
반환
Promise<AssociatedWorkItem[]>
getTfvcStatistics(string, string)
TFVC에 대한 특정 scope 컬렉션/프로젝트에 대한 파일 수 및 압축되지 않은 바이트를 제공합니다.
function getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- scopePath
-
string
컬렉션의 경우 '$/', 특정 프로젝트의 경우 '$/project'
반환
Promise<TfvcStatistics>