WikiPage interface

  • Reference
Package:
azure-devops-extension-api

Defines a page in a wiki.

Extends
WikiPageCreateOrUpdateParameters

Properties

gitItemPath

Path of the git item corresponding to the wiki page stored in the backing Git repository.
id

When present, permanent identifier for the wiki page
isNonConformant

True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.
isParentPage

True if this page has subpages under its path.
order

Order of the wiki page, relative to other pages in the same hierarchy level.
path

Path of the wiki page.
remoteUrl

Remote web url to the wiki page.
subPages

List of subpages of the current page.
url

REST url for this wiki page.

Inherited Properties

content

Content of the wiki page.

Property Details

gitItemPath

Path of the git item corresponding to the wiki page stored in the backing Git repository.

gitItemPath: string

Property Value

string

id

When present, permanent identifier for the wiki page

id: number

Property Value

number

isNonConformant

True if a page is non-conforming, i.e. 1) if the name doesn't match page naming standards. 2) if the page does not have a valid entry in the appropriate order file.

isNonConformant: boolean

Property Value

boolean

isParentPage

True if this page has subpages under its path.

isParentPage: boolean

Property Value

boolean

order

Order of the wiki page, relative to other pages in the same hierarchy level.

order: number

Property Value

number

path

Path of the wiki page.

path: string

Property Value

string

remoteUrl

Remote web url to the wiki page.

remoteUrl: string

Property Value

string

subPages

List of subpages of the current page.

subPages: WikiPage[]

Property Value

WikiPage[]

url

REST url for this wiki page.

url: string

Property Value

string

Inherited Property Details

content

Content of the wiki page.

content: string

Property Value

string

Inherited From WikiPageCreateOrUpdateParameters.content