interface IWikiApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addComment(
        request: CommentCreateParameters,
        project: string,
        wikiIdentifier: string,
        pageId: number,
    ): Promise<Comment>;
    addCommentReaction(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        commentId: number,
        type: CommentReactionType,
    ): Promise<CommentReaction>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createCommentAttachment(
        customHeaders: any,
        contentStream: ReadableStream,
        project: string,
        wikiIdentifier: string,
        pageId: number,
    ): Promise<CommentAttachment>;
    createOrUpdatePageViewStats(
        project: string,
        wikiIdentifier: string,
        wikiVersion: GitVersionDescriptor,
        path: string,
        oldPath?: string,
    ): Promise<WikiPageViewStats>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createWiki(
        wikiCreateParams: WikiCreateParametersV2,
        project?: string,
    ): Promise<WikiV2>;
    deleteComment(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        id: number,
    ): Promise<void>;
    deleteCommentReaction(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        commentId: number,
        type: CommentReactionType,
    ): Promise<CommentReaction>;
    deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAllWikis(project?: string): Promise<WikiV2[]>;
    getAttachmentContent(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        attachmentId: string,
    ): Promise<ReadableStream>;
    getComment(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        id: number,
        excludeDeleted?: boolean,
        expand?: CommentExpandOptions,
    ): Promise<Comment>;
    getEngagedUsers(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        commentId: number,
        type: CommentReactionType,
        top?: number,
        skip?: number,
    ): Promise<IdentityRef[]>;
    getPageByIdText(
        project: string,
        wikiIdentifier: string,
        id: number,
        recursionLevel?: VersionControlRecursionType,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getPageByIdZip(
        project: string,
        wikiIdentifier: string,
        id: number,
        recursionLevel?: VersionControlRecursionType,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getPageData(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        pageViewsForDays?: number,
    ): Promise<WikiPageDetail>;
    getPagesBatch(
        pagesBatchRequest: WikiPagesBatchRequest,
        project: string,
        wikiIdentifier: string,
        versionDescriptor?: GitVersionDescriptor,
    ): Promise<PagedList<WikiPageDetail>>;
    getPageText(
        project: string,
        wikiIdentifier: string,
        path?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: GitVersionDescriptor,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getPageZip(
        project: string,
        wikiIdentifier: string,
        path?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: GitVersionDescriptor,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>;
    listComments(
        project: string,
        wikiIdentifier: string,
        pageId: number,
        top?: number,
        continuationToken?: string,
        excludeDeleted?: boolean,
        expand?: CommentExpandOptions,
        order?: CommentSortOrder,
        parentId?: number,
    ): Promise<CommentList>;
    updateComment(
        comment: CommentUpdateParameters,
        project: string,
        wikiIdentifier: string,
        pageId: number,
        id: number,
    ): Promise<Comment>;
    updateWiki(
        updateParameters: WikiUpdateParameters,
        wikiIdentifier: string,
        project?: string,
    ): Promise<WikiV2>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • project: string
    • wikiIdentifier: string
    • pageId: number
    • id: number

    Returns Promise<void>

  • Parameters

    • project: string
    • wikiIdentifier: string
    • pageId: number
    • attachmentId: string

    Returns Promise<ReadableStream>