Interface WikiPage

Defines a page in a wiki.

interface WikiPage {
    content?: string;
    gitItemPath?: string;
    id?: number;
    isNonConformant?: boolean;
    isParentPage?: boolean;
    order?: number;
    path?: string;
    remoteUrl?: string;
    subPages?: WikiPage[];
    url?: string;
}

Hierarchy (View Summary)

Properties

content? gitItemPath? id? isNonConformant? isParentPage? order? path? remoteUrl? subPages? url?

Properties

Optionalcontent

content?: string

Content of the wiki page.

OptionalgitItemPath

gitItemPath?: string

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

Optionalid

id?: number

When present, permanent identifier for the wiki page

OptionalisNonConformant

isNonConformant?: boolean

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.

OptionalisParentPage

isParentPage?: boolean

True if this page has subpages under its path.

Optionalorder

order?: number

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

Optionalpath

path?: string

Path of the wiki page.

OptionalremoteUrl

remoteUrl?: string

Remote web url to the wiki page.

OptionalsubPages

subPages?: WikiPage[]

List of subpages of the current page.

Optionalurl

url?: string

REST url for this wiki page.

Settings

Member Visibility

On This Page

Properties