Class WikiApi

constructor

• new WikiApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): WikiApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns WikiApi

Static ReadonlyRESOURCE_AREA_ID

addComment

• addComment(
      request: CommentCreateParameters,
      project: string,
      wikiIdentifier: string,
      pageId: number,
  ): Promise<Comment>

  Add a comment on a wiki page.

  Parameters

  • request: CommentCreateParameters

    Comment create request.
  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.

  Returns Promise<Comment>

addCommentReaction

• addCommentReaction(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      commentId: number,
      type: CommentReactionType,
  ): Promise<CommentReaction>

  Add a reaction on a wiki page comment.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name
  • pageId: number

    Wiki page ID
  • commentId: number

    ID of the associated comment
  • type: CommentReactionType

    Type of the reaction being added

  Returns Promise<CommentReaction>

createCommentAttachment

• createCommentAttachment(
      customHeaders: any,
      contentStream: ReadableStream,
      project: string,
      wikiIdentifier: string,
      pageId: number,
  ): Promise<CommentAttachment>

  Uploads an attachment on a comment on a wiki page.

  Parameters

  • customHeaders: any
  • contentStream: ReadableStream

    Content to upload
  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.

  Returns Promise<CommentAttachment>

createOrUpdatePageViewStats

• createOrUpdatePageViewStats(
      project: string,
      wikiIdentifier: string,
      wikiVersion: GitVersionDescriptor,
      path: string,
      oldPath?: string,
  ): Promise<WikiPageViewStats>

  Creates a new page view stats resource or updates an existing page view stats resource.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • wikiVersion: GitVersionDescriptor

    Wiki version.
  • path: string

    Wiki page path.
  • OptionaloldPath: string

    Old page path. This is optional and required to rename path in existing page view stats.

  Returns Promise<WikiPageViewStats>

createWiki

• createWiki(
      wikiCreateParams: WikiCreateParametersV2,
      project?: string,
  ): Promise<WikiV2>

  Creates the wiki resource.

  Parameters

  • wikiCreateParams: WikiCreateParametersV2

    Parameters for the wiki creation.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WikiV2>

deleteComment

• deleteComment(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      id: number,
  ): Promise<void>

  Delete a comment on a wiki page.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or name.
  • pageId: number

    Wiki page ID.
  • id: number

    Comment ID.

  Returns Promise<void>

deleteCommentReaction

• deleteCommentReaction(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      commentId: number,
      type: CommentReactionType,
  ): Promise<CommentReaction>

  Delete a reaction on a wiki page comment.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or name
  • pageId: number

    Wiki page ID
  • commentId: number

    ID of the associated comment
  • type: CommentReactionType

    Type of the reaction being deleted

  Returns Promise<CommentReaction>

deleteWiki

• deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>

  Deletes the wiki corresponding to the wiki ID or wiki name provided.

  Parameters

  • wikiIdentifier: string

    Wiki ID or wiki name.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WikiV2>

getAllWikis

• getAllWikis(project?: string): Promise<WikiV2[]>

  Gets all wikis in a project or collection.

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<WikiV2[]>

getAttachmentContent

• getAttachmentContent(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      attachmentId: string,
  ): Promise<ReadableStream>

  Downloads an attachment on a comment on a wiki page.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • attachmentId: string

    Attachment ID.

  Returns Promise<ReadableStream>

getComment

• getComment(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      id: number,
      excludeDeleted?: boolean,
      expand?: CommentExpandOptions,
  ): Promise<Comment>

  Returns a comment associated with the Wiki Page.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • id: number

    ID of the comment to return.
  • OptionalexcludeDeleted: boolean

    Specify if the deleted comment should be skipped.
  • Optionalexpand: CommentExpandOptions

    Specifies the additional data retrieval options for comments.

  Returns Promise<Comment>

getEngagedUsers

• getEngagedUsers(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      commentId: number,
      type: CommentReactionType,
      top?: number,
      skip?: number,
  ): Promise<IdentityRef[]>

  Gets a list of users who have reacted for the given wiki comment with a given reaction type. Supports paging, with a default page size of 100 users at a time.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • commentId: number

    ID of the associated comment
  • type: CommentReactionType

    Type of the reaction for which the engaged users are being requested
  • Optionaltop: number

    Number of enagaged users to be returned in a given page. Optional, defaults to 100
  • Optionalskip: number

    Number of engaged users to be skipped to page the next set of engaged users, defaults to 0

  Returns Promise<IdentityRef[]>

getPageByIdText

• getPageByIdText(
      project: string,
      wikiIdentifier: string,
      id: number,
      recursionLevel?: VersionControlRecursionType,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the Accept header sent in the request.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name..
  • id: number

    Wiki page ID.
  • OptionalrecursionLevel: VersionControlRecursionType

    Recursion level for subpages retrieval. Defaults to None (Optional).
  • OptionalincludeContent: boolean

    True to include the content of the page in the response for Json content type. Defaults to false (Optional)

  Returns Promise<ReadableStream>

getPageByIdZip

• getPageByIdZip(
      project: string,
      wikiIdentifier: string,
      id: number,
      recursionLevel?: VersionControlRecursionType,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Gets metadata or content of the wiki page for the provided page id. Content negotiation is done based on the Accept header sent in the request.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name..
  • id: number

    Wiki page ID.
  • OptionalrecursionLevel: VersionControlRecursionType

    Recursion level for subpages retrieval. Defaults to None (Optional).
  • OptionalincludeContent: boolean

    True to include the content of the page in the response for Json content type. Defaults to false (Optional)

  Returns Promise<ReadableStream>

getPageData

• getPageData(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      pageViewsForDays?: number,
  ): Promise<WikiPageDetail>

  Returns page detail corresponding to Page ID.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • OptionalpageViewsForDays: number

    last N days from the current day for which page views is to be returned. It's inclusive of current day.

  Returns Promise<WikiPageDetail>

getPagesBatch

• getPagesBatch(
      pagesBatchRequest: WikiPagesBatchRequest,
      project: string,
      wikiIdentifier: string,
      versionDescriptor?: GitVersionDescriptor,
  ): Promise<PagedList<WikiPageDetail>>

  Returns pageable list of Wiki Pages

  Parameters

  • pagesBatchRequest: WikiPagesBatchRequest

    Wiki batch page request.
  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • OptionalversionDescriptor: GitVersionDescriptor

    GitVersionDescriptor for the page. (Optional in case of ProjectWiki).

  Returns Promise<PagedList<WikiPageDetail>>

getPageText

• getPageText(
      project: string,
      wikiIdentifier: string,
      path?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: GitVersionDescriptor,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • Optionalpath: string

    Wiki page path.
  • OptionalrecursionLevel: VersionControlRecursionType

    Recursion level for subpages retrieval. Defaults to None (Optional).
  • OptionalversionDescriptor: GitVersionDescriptor

    GitVersionDescriptor for the page. Defaults to the default branch (Optional).
  • OptionalincludeContent: boolean

    True to include the content of the page in the response for Json content type. Defaults to false (Optional)

  Returns Promise<ReadableStream>

getPageZip

• getPageZip(
      project: string,
      wikiIdentifier: string,
      path?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: GitVersionDescriptor,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Gets metadata or content of the wiki page for the provided path. Content negotiation is done based on the Accept header sent in the request.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • Optionalpath: string

    Wiki page path.
  • OptionalrecursionLevel: VersionControlRecursionType

    Recursion level for subpages retrieval. Defaults to None (Optional).
  • OptionalversionDescriptor: GitVersionDescriptor

    GitVersionDescriptor for the page. Defaults to the default branch (Optional).
  • OptionalincludeContent: boolean

    True to include the content of the page in the response for Json content type. Defaults to false (Optional)

  Returns Promise<ReadableStream>

getWiki

• getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>

  Gets the wiki corresponding to the wiki ID or wiki name provided.

  Parameters

  • wikiIdentifier: string

    Wiki ID or wiki name.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WikiV2>

listComments

• listComments(
      project: string,
      wikiIdentifier: string,
      pageId: number,
      top?: number,
      continuationToken?: string,
      excludeDeleted?: boolean,
      expand?: CommentExpandOptions,
      order?: CommentSortOrder,
      parentId?: number,
  ): Promise<CommentList>

  Returns a pageable list of comments.

  Parameters

  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • Optionaltop: number

    Max number of comments to return.
  • OptionalcontinuationToken: string

    Used to query for the next page of comments.
  • OptionalexcludeDeleted: boolean

    Specify if the deleted comments should be skipped.
  • Optionalexpand: CommentExpandOptions

    Specifies the additional data retrieval options for comments.
  • Optionalorder: CommentSortOrder

    Order in which the comments should be returned.
  • OptionalparentId: number

    CommentId of the parent comment.

  Returns Promise<CommentList>

updateComment

• updateComment(
      comment: CommentUpdateParameters,
      project: string,
      wikiIdentifier: string,
      pageId: number,
      id: number,
  ): Promise<Comment>

  Update a comment on a wiki page.

  Parameters

  • comment: CommentUpdateParameters

    Comment update request.
  • project: string

    Project ID or project name
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • pageId: number

    Wiki page ID.
  • id: number

    Comment ID.

  Returns Promise<Comment>

updateWiki

• updateWiki(
      updateParameters: WikiUpdateParameters,
      wikiIdentifier: string,
      project?: string,
  ): Promise<WikiV2>

  Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.

  Parameters

  • updateParameters: WikiUpdateParameters

    Update parameters.
  • wikiIdentifier: string

    Wiki ID or wiki name.
  • Optionalproject: string

    Project ID or project name

  Returns Promise<WikiV2>