Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PagesApi

Hierarchy

  • PagesApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PagesApi(basePath?: string): PagesApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

addPage

  • addPage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Page>

  • Adds a page to the work item form

    Parameters

    • params: object
      • apiVersion: string
      • body: Page
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Page>

addPage_1

  • addPage_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Page>

  • Adds a page to the work item form.

    Parameters

    • params: object
      • apiVersion: string
      • body: Page
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Page>

createOrUpdatePage

  • createOrUpdatePage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • Creates or edits a wiki page.

    Parameters

    • params: object
      • apiVersion: string
      • body: WikiPageCreateOrUpdateParameters
      • Optional comment?: string
      • organization: string
      • path: string
      • project: string
      • version: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

deletePage

  • deletePage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • Deletes a wiki page.

    Parameters

    • params: object
      • apiVersion: string
      • Optional comment?: string
      • organization: string
      • path: string
      • project: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

deletePageById

  • deletePageById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • Deletes a wiki page.

    Parameters

    • params: object
      • apiVersion: string
      • Optional comment?: string
      • id: number
      • organization: string
      • project: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

editPage

  • editPage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Page>

  • Updates a page on the work item form

    Parameters

    • params: object
      • apiVersion: string
      • body: Page
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Page>

getPage

  • getPage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • 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

    • params: object
      • apiVersion: string
      • Optional includeContent?: boolean
      • organization: string
      • Optional path?: string
      • project: string
      • Optional recursionLevel?: string
      • Optional versionDescriptorVersion?: string
      • Optional versionDescriptorVersionOptions?: string
      • Optional versionDescriptorVersionType?: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

getPageById

  • getPageById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • 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

    • params: object
      • apiVersion: string
      • id: number
      • Optional includeContent?: boolean
      • organization: string
      • project: string
      • Optional recursionLevel?: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

removePage

  • removePage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Removes a page from the work item form

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • pageId: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

removePage_2

  • removePage_2(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Removes a page from the work item form

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • pageId: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

updatePage

  • updatePage(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Page>

  • Updates a page on the work item form

    Parameters

    • params: object
      • apiVersion: string
      • body: Page
      • organization: string
      • processId: string
      • witRefName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Page>

updatePageById

  • updatePageById(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WikiPage>

  • Edits a wiki page.

    Parameters

    • params: object
      • apiVersion: string
      • body: WikiPageCreateOrUpdateParameters
      • Optional comment?: string
      • id: number
      • organization: string
      • project: string
      • version: string
      • wikiIdentifier: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<WikiPage>

Generated using TypeDoc