Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

confluenceConfig

confluenceConfig: function

Type declaration

    • (): any
    • Returns any

upmAction

upmAction: ConfluenceAction = new ConfluenceAction({path: "plugins/servlet/upm",})

Methods

addLicense

  • addLicense(pluginName: string, licenseKey: string): void
  • Parameters

    • pluginName: string
    • licenseKey: string

    Returns void

authenticate

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

    • Optional password: string

    Returns void

authenticateAsAdmin

  • authenticateAsAdmin(): void

confluenceVersion

currentUsername

  • currentUsername(): Promise<string>

disableNotifications

  • disableNotifications(): void

disablePlugin

  • disablePlugin(pluginName: string): void
  • Parameters

    • pluginName: string

    Returns void

disableSynchrony

  • disableSynchrony(): void

enablePlugin

  • enablePlugin(pluginName: string): void
  • Parameters

    • pluginName: string

    Returns void

getParamFromAJS

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

    • paramName: string
    • Optional defaultValue: any

    Returns Promise<string>

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

openAdminPage

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

    • Default value path: string = "admin"

    Returns void

Private openPlugin

  • openPlugin(pluginName: string): any
  • Parameters

    • pluginName: string

    Returns any

parseMavenVersionFromPom

  • parseMavenVersionFromPom(): string
  • Returns string

pluginEnabled

  • pluginEnabled(pluginName: string): Promise<boolean>
  • Parameters

    • pluginName: string

    Returns Promise<boolean>

pluginInstalled

  • pluginInstalled(pluginName: string): Promise<boolean>
  • Parameters

    • pluginName: string

    Returns Promise<boolean>

pluginLicensed

  • pluginLicensed(pluginName: string): Promise<boolean>
  • Parameters

    • pluginName: string

    Returns Promise<boolean>

removeLicense

  • removeLicense(pluginName: string): void
  • Parameters

    • pluginName: string

    Returns void

resetConfluenceVersion

  • resetConfluenceVersion(): void

skipNotifications

  • skipNotifications(): void

uninstallPlugin

  • uninstallPlugin(pluginKey: string): void
  • Parameters

    • pluginKey: string

    Returns void

uploadPlugin

  • uploadPlugin(pluginName: string, fileToUpload: string, timeout?: number, maxAttempts?: number): void
  • Parameters

    • pluginName: string
    • fileToUpload: string
    • Default value timeout: number = DEFAULT_PLUGIN_UPLOAD_TIMEOUT
    • Default value maxAttempts: number = DEFAULT_MAX_ATTEMPTS

    Returns void

Private uploadPluginInternal

  • uploadPluginInternal(pluginName: string, fileToUpload: string, timeout?: number, maxAttempts?: number, attemptCount?: number): void
  • Parameters

    • pluginName: string
    • fileToUpload: string
    • Default value timeout: number = DEFAULT_PLUGIN_UPLOAD_TIMEOUT
    • Default value maxAttempts: number = DEFAULT_MAX_ATTEMPTS
    • Default value attemptCount: number = 1

    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