Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfluenceUser

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • new ConfluenceUser(username: string, fullName: string, email: string, password: string): ConfluenceUser

Properties

confluenceConfig

confluenceConfig: function

Type declaration

    • (): any

    • Returns any

email

email: string

fullName

fullName: string

password

password: string

personalSpace

personalSpace: ConfluenceSpace

userActions

userActions: UserActions

username

username: string

Methods

addGroup

  • addGroup(groupname: string): Promise<void>

  • Parameters

    • groupname: string

    Returns Promise<void>

authenticate

  • authenticate(password?: string): void

  • Parameters

    • Optional password: string

    Returns void

authenticateAsAdmin

  • authenticateAsAdmin(): void

Private changeGroup

  • changeGroup(groupname: string, operation: string): Promise<void>

  • Parameters

    • groupname: string
    • operation: string

    Returns Promise<void>

confluenceVersion

create

  • create(): void

  • Returns void

createIfNotExists

  • createIfNotExists(): void

  • Returns void

createPersonalSpace

  • createPersonalSpace(): Promise<void>

  • Returns Promise<void>

currentUsername

  • currentUsername(): Promise<string>

disableNotifications

  • disableNotifications(): void

disableSynchrony

  • disableSynchrony(): void

getParamFromAJS

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

  • Parameters

    • paramName: string
    • Optional defaultValue: any

    Returns Promise<string>

Private groupSelector

  • groupSelector(groupName: string): By

  • Parameters

    • groupName: string

    Returns By

hasGroup

  • hasGroup(groupName: string): Promise<boolean>

  • Parameters

    • groupName: string

    Returns Promise<boolean>

isInGroup

  • isInGroup(groupName: string): Promise<boolean>

  • Parameters

    • groupName: string

    Returns Promise<boolean>

isInSearchIndex

  • isInSearchIndex(): Promise<boolean>

  • Returns Promise<boolean>

loadConfluenceVersion

  • loadConfluenceVersion(): Promise<Version>

login

  • login(loginUsername?: string, loginPassword?: string): void

  • Parameters

    • Optional loginUsername: string
    • Optional loginPassword: string

    Returns void

loginAsAdmin

  • loginAsAdmin(): void

logout

  • logout(): void

openAdminPage

  • openAdminPage(path?: string): void

  • Parameters

    • Default value path: string = "admin"

    Returns void

remove

  • remove(): void

  • Returns void

removeGroup

  • removeGroup(groupname: string): Promise<void>

  • Parameters

    • groupname: string

    Returns Promise<void>

removePersonalSpace

  • removePersonalSpace(): void

  • Returns void

resetConfluenceVersion

  • resetConfluenceVersion(): void

skipNotifications

  • skipNotifications(): void

viewPersonalSpace

  • viewPersonalSpace(): void

  • Returns void

waitUntilUserAppearsInGroup

  • waitUntilUserAppearsInGroup(groupName: string): Promise<Object>

  • Parameters

    • groupName: string

    Returns Promise<Object>

waitUntilUserDisappearsFromGroup

  • waitUntilUserDisappearsFromGroup(groupName: string): void

  • Parameters

    • groupName: string

    Returns void

waitUntilUserInSearchIndex

  • waitUntilUserInSearchIndex(): Promise<Object>

  • Returns Promise<Object>

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