WikiRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
static RESOURCE_AREA_ID: string속성 값
string
위키 페이지에 메모를 추가합니다.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>매개 변수
- request
- CommentCreateParameters
주석 만들기 요청.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
반환
Promise<Comment>
위키 페이지 주석에 반응을 추가합니다.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름
- pageId
-
number
Wiki 페이지 ID
- commentId
-
number
연결된 주석의 ID
- type
- CommentReactionType
추가되는 반응의 유형
반환
Promise<CommentReaction>
위키 페이지의 메모에 첨부 파일을 업로드합니다.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>매개 변수
- content
-
any
업로드할 콘텐츠
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
반환
Promise<CommentAttachment>
새 페이지 보기 통계 리소스를 만들거나 기존 페이지 보기 통계 리소스를 업데이트합니다.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- wikiVersion
- GitVersionDescriptor
Wiki 버전입니다.
- path
-
string
Wiki 페이지 경로입니다.
- oldPath
-
string
이전 페이지 경로입니다. 이는 선택 사항이며 기존 페이지 보기 통계에서 경로 이름을 바꾸는 데 필요합니다.
반환
Promise<WikiPageViewStats>
wiki 리소스를 만듭니다.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>매개 변수
- wikiCreateParams
- WikiCreateParametersV2
위키 만들기에 대한 매개 변수입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WikiV2>
위키 페이지에서 메모를 삭제합니다.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- id
-
number
주석 ID입니다.
반환
Promise<void>
위키 페이지 주석에서 반응을 삭제합니다.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 이름
- pageId
-
number
Wiki 페이지 ID
- commentId
-
number
연결된 주석의 ID
- type
- CommentReactionType
삭제되는 반응의 유형
반환
Promise<CommentReaction>
제공된 위키 ID 또는 위키 이름에 해당하는 wiki를 삭제합니다.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>매개 변수
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WikiV2>
프로젝트 또는 컬렉션의 모든 Wiki를 가져옵니다.
function getAllWikis(project?: string): Promise<WikiV2[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WikiV2[]>
위키 페이지의 메모에 첨부 파일을 다운로드합니다.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- attachmentId
-
string
첨부 파일 ID입니다.
반환
Promise<ArrayBuffer>
Wiki 페이지와 연결된 메모를 반환합니다.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- id
-
number
반환할 주석의 ID입니다.
- excludeDeleted
-
boolean
삭제된 주석을 건너뛸지 지정합니다.
- expand
- CommentExpandOptions
주석에 대한 추가 데이터 검색 옵션을 지정합니다.
반환
Promise<Comment>
지정된 반응 유형으로 지정된 wiki 주석에 대해 반응한 사용자 목록을 가져옵니다. 한 번에 100명의 사용자로 구성된 기본 페이지 크기로 페이징을 지원합니다.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- commentId
-
number
연결된 주석의 ID
- type
- CommentReactionType
참여하는 사용자가 요청되는 반응의 유형
- top
-
number
지정된 페이지에서 반환할 열거된 사용자 수입니다. 선택 사항이며 기본값은 100입니다.
- skip
-
number
다음 참여 사용자 집합을 페이징하기 위해 건너뛸 참여 사용자 수이며 기본값은 0입니다.
반환
Promise<IdentityRef[]>
제공된 페이지 ID에 대한 위키 페이지의 메타데이터 또는 콘텐츠를 가져옵니다. 콘텐츠 협상은 요청에서 전송된 헤더를 Accept 기반으로 수행됩니다.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- id
-
number
Wiki 페이지 ID입니다.
- recursionLevel
- VersionControlRecursionType
하위 페이지 검색에 대한 재귀 수준입니다. 기본값은 None (선택 사항)입니다.
- includeContent
-
boolean
True이면 Json 콘텐츠 형식에 대한 응답에 페이지의 콘텐츠를 포함합니다. 기본값은 false입니다(선택 사항).
반환
Promise<string>
제공된 페이지 ID에 대한 위키 페이지의 메타데이터 또는 콘텐츠를 가져옵니다. 콘텐츠 협상은 요청에서 전송된 헤더를 Accept 기반으로 수행됩니다.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- id
-
number
Wiki 페이지 ID입니다.
- recursionLevel
- VersionControlRecursionType
하위 페이지 검색에 대한 재귀 수준입니다. 기본값은 None (선택 사항)입니다.
- includeContent
-
boolean
True이면 Json 콘텐츠 형식에 대한 응답에 페이지의 콘텐츠를 포함합니다. 기본값은 false입니다(선택 사항).
반환
Promise<ArrayBuffer>
페이지 ID에 해당하는 페이지 세부 정보를 반환합니다.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- pageViewsForDays
-
number
페이지 보기를 반환할 현재 날짜로부터 지난 N일입니다. 그것은 현재의 날을 포함합니다.
반환
Promise<WikiPageDetail>
위키 페이지의 페이지를 표시할 수 있는 목록을 반환합니다.
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>매개 변수
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki 일괄 처리 페이지 요청.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- versionDescriptor
- GitVersionDescriptor
페이지의 GitVersionDescriptor입니다. (ProjectWiki의 경우 선택 사항).
반환
Promise<PagedList<WikiPageDetail>>
제공된 경로에 대한 위키 페이지의 메타데이터 또는 콘텐츠를 가져옵니다. 콘텐츠 협상은 요청에서 전송된 헤더를 Accept 기반으로 수행됩니다.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- path
-
string
Wiki 페이지 경로입니다.
- recursionLevel
- VersionControlRecursionType
하위 페이지 검색에 대한 재귀 수준입니다. 기본값은 None (선택 사항)입니다.
- versionDescriptor
- GitVersionDescriptor
페이지의 GitVersionDescriptor입니다. 기본값은 기본 분기(선택 사항)입니다.
- includeContent
-
boolean
True이면 Json 콘텐츠 형식에 대한 응답에 페이지의 콘텐츠를 포함합니다. 기본값은 false입니다(선택 사항).
반환
Promise<string>
제공된 경로에 대한 위키 페이지의 메타데이터 또는 콘텐츠를 가져옵니다. 콘텐츠 협상은 요청에서 전송된 헤더를 Accept 기반으로 수행됩니다.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- path
-
string
Wiki 페이지 경로입니다.
- recursionLevel
- VersionControlRecursionType
하위 페이지 검색에 대한 재귀 수준입니다. 기본값은 None (선택 사항)입니다.
- versionDescriptor
- GitVersionDescriptor
페이지의 GitVersionDescriptor입니다. 기본값은 기본 분기(선택 사항)입니다.
- includeContent
-
boolean
True이면 Json 콘텐츠 형식에 대한 응답에 페이지의 콘텐츠를 포함합니다. 기본값은 false입니다(선택 사항).
반환
Promise<ArrayBuffer>
제공된 위키 ID 또는 위키 이름에 해당하는 위키를 가져옵니다.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>매개 변수
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
페이지가 지정 가능한 메모 목록을 반환합니다.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- top
-
number
반환할 최대 주석 수입니다.
- continuationToken
-
string
주석의 다음 페이지를 쿼리하는 데 사용됩니다.
- excludeDeleted
-
boolean
삭제된 주석을 건너뛸지 지정합니다.
- expand
- CommentExpandOptions
주석에 대한 추가 데이터 검색 옵션을 지정합니다.
- order
- CommentSortOrder
주석을 반환해야 하는 순서입니다.
- parentId
-
number
부모 주석의 CommentId입니다.
반환
Promise<CommentList>
위키 페이지에서 주석을 업데이트합니다.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>매개 변수
- comment
- CommentUpdateParameters
주석 업데이트 요청.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- pageId
-
number
Wiki 페이지 ID입니다.
- id
-
number
주석 ID입니다.
반환
Promise<Comment>
업데이트 매개 변수를 사용하여 제공된 wiki ID 또는 wiki 이름에 해당하는 wiki를 업데이트.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>매개 변수
- updateParameters
- WikiUpdateParameters
매개 변수를 업데이트합니다.
- wikiIdentifier
-
string
Wiki ID 또는 wiki 이름입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<WikiV2>