Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new ConfluencePage(pageName: string, spaceKey: string): ConfluencePage

Properties

confluenceConfig

confluenceConfig: function

Type declaration

    • (): any
    • Returns any

pageActions

pageActions: PageActions

pageEditor

pageEditor: ConfluenceEditor = new ConfluenceEditor()

Private pageName

pageName: string

Private spaceKey

spaceKey: string

Methods

addLabels

  • addLabels(labels: string[]): void
  • Parameters

    • labels: string[]

    Returns void

authenticate

  • authenticate(password?: string): void
  • Parameters

    • Optional password: string

    Returns void

authenticateAsAdmin

  • authenticateAsAdmin(): void

confluenceVersion

copyPage

  • Parameters

    • Optional pageName: string

    Returns ConfluencePage

create

  • create(): void
  • Returns void

currentUsername

  • currentUsername(): Promise<string>

disableNotifications

  • disableNotifications(): void

disableSynchrony

  • disableSynchrony(): void

edit

  • edit(): void
  • Returns void

getComments

  • getComments(): ElementArrayFinder
  • Returns ElementArrayFinder

getEditor

getLabelSuggestions

  • getLabelSuggestions(label: string): ElementArrayFinder
  • Parameters

    • label: string

    Returns ElementArrayFinder

getLatestComment

  • getLatestComment(): ElementFinder
  • Returns ElementFinder

getLatestCommentContent

  • getLatestCommentContent(): any
  • Returns any

getPageName

  • getPageName(): string
  • Returns string

getParamFromAJS

  • getParamFromAJS(paramName: string, defaultValue?: any): Promise<string>
  • Parameters

    • paramName: string
    • Optional defaultValue: any

    Returns Promise<string>

getSpaceKey

  • getSpaceKey(): string
  • Returns string

hasComments

  • hasComments(): any
  • Returns any

loadConfluenceVersion

  • loadConfluenceVersion(): Promise<Version>

login

  • login(username?: string, password?: string): void
  • Parameters

    • Optional username: string
    • Optional password: string

    Returns void

loginAsAdmin

  • loginAsAdmin(): void

logout

  • logout(): void

newPage

  • newPage(): void
  • Returns void

open

  • open(): void
  • Returns void

openActionMenu

  • openActionMenu(): void
  • Returns void

openAdminPage

  • openAdminPage(path?: string): void
  • Parameters

    • Default value path: string = "admin"

    Returns void

Private openLabelEditor

  • openLabelEditor(): By
  • Returns By

remove

  • remove(): void
  • Returns void

removeLatestComment

  • removeLatestComment(): void
  • Returns void

resetConfluenceVersion

  • resetConfluenceVersion(): void

Private sendLabelToInput

  • sendLabelToInput(label: string): void
  • Parameters

    • label: string

    Returns void

Private setPageName

  • setPageName(pageName: string): void
  • Parameters

    • pageName: string

    Returns void

skipNotifications

  • skipNotifications(): void

skipRemovalNotificationIfPresent

  • skipRemovalNotificationIfPresent(): void
  • Returns void

Object literals

actions

actions: object

authenticate

authenticate: ConfluenceAction = new ConfluenceAction({path: "authenticate.action",})

login

login: ConfluenceAction = new ConfluenceAction({path: "login.action",})

logout

logout: ConfluenceAction = new ConfluenceAction({path: "logout.action",})

Generated using TypeDoc