FileContainerRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| File |
메서드
| create |
참조된 컨테이너에 지정된 항목을 만듭니다. |
| delete |
컨테이너에서 지정된 항목을 삭제합니다. |
| get |
동일한 scope 내의 쉼표로 구분된 아티팩트 URI 목록으로 필터링된 컨테이너를 가져오며, 지정하지 않으면 모든 컨테이너가 반환됩니다. |
| get |
지정된 매개 변수 또는 HTTP Accept 요청 헤더에 종속된 형식으로 지정된 파일 컨테이너 개체를 가져옵니다. |
생성자 세부 정보
FileContainerRestClient(IVssRestClientOptions)
메서드 세부 정보
createItems(VssJsonCollectionWrapperV<FileContainerItem[]>, number, string)
참조된 컨테이너에 지정된 항목을 만듭니다.
function createItems(items: VssJsonCollectionWrapperV<FileContainerItem[]>, containerId: number, scope?: string): Promise<FileContainerItem[]>매개 변수
- containerId
-
number
- scope
-
string
컨테이너의 scope 나타내는 guid입니다. 프로젝트 ID인 경우가 많습니다.
반환
Promise<FileContainerItem[]>
deleteItem(number, string, string)
컨테이너에서 지정된 항목을 삭제합니다.
function deleteItem(containerId: number, itemPath: string, scope?: string): Promise<void>매개 변수
- containerId
-
number
컨테이너 ID입니다.
- itemPath
-
string
삭제할 경로입니다.
- scope
-
string
컨테이너의 scope 나타내는 guid입니다. 프로젝트 ID인 경우가 많습니다.
반환
Promise<void>
getContainers(string, string)
동일한 scope 내의 쉼표로 구분된 아티팩트 URI 목록으로 필터링된 컨테이너를 가져오며, 지정하지 않으면 모든 컨테이너가 반환됩니다.
function getContainers(scope?: string, artifactUris?: string): Promise<FileContainer[]>매개 변수
- scope
-
string
컨테이너의 scope 나타내는 guid입니다. 프로젝트 ID인 경우가 많습니다.
- artifactUris
-
string
반환
Promise<FileContainer[]>
getItems(number, string, string, boolean, string, string, boolean, boolean, boolean, boolean, boolean, boolean)
지정된 매개 변수 또는 HTTP Accept 요청 헤더에 종속된 형식으로 지정된 파일 컨테이너 개체를 가져옵니다.
function getItems(containerId: number, scope?: string, itemPath?: string, metadata?: boolean, format?: string, downloadFileName?: string, includeDownloadTickets?: boolean, isShallow?: boolean, ignoreRequestedMediaType?: boolean, includeBlobMetadata?: boolean, saveAbsolutePath?: boolean, preferRedirect?: boolean): Promise<FileContainerItem[]>매개 변수
- containerId
-
number
요청된 컨테이너 ID
- scope
-
string
컨테이너의 scope 나타내는 guid입니다. 프로젝트 ID인 경우가 많습니다.
- itemPath
-
string
관심 항목의 경로
- metadata
-
boolean
true이면 지정된 format 매개 변수 또는 HTTP Accept 요청 헤더를 재정의하여 지정된 itemPath에 대한 비귀적 정보를 제공합니다.
- format
-
string
지정된 경우 HTTP 수락 요청 헤더를 재정의하여 'json' 또는 'zip'을 반환합니다. $format 지정한 경우 api-version도 쿼리 매개 변수로 지정해야 합니다.
- downloadFileName
-
string
JSON 형식 이외의 를 지정하고 반환하는 경우 이 다운로드 이름이 사용됩니다(그렇지 않으면 itemPath로 기본 설정).
- includeDownloadTickets
-
boolean
- isShallow
-
boolean
true이면 지정된 itemPath에 대해 직접 자식(파일 & 폴더)만 반환합니다. False이면 itemPath 내에서 모든 항목이 재귀적으로 반환됩니다.
- ignoreRequestedMediaType
-
boolean
HTTP 수락 요청 헤더를 무시하려면 true로 설정합니다. 기본값은 false입니다.
- includeBlobMetadata
-
boolean
- saveAbsolutePath
-
boolean
반환된 보관 파일에 있는 아티팩트에서 지정된 디렉터리에 대한 절대 경로를 저장하지 않려면 false로 설정합니다. 아티팩트 디렉터리에 대해서만 작동합니다. 기본값은 true입니다.
- preferRedirect
-
boolean
콘텐츠를 사용하여 스트림으로 이어지는 리디렉션 응답을 얻으려면 true로 설정합니다. 기본값은 false입니다.
반환
Promise<FileContainerItem[]>