PersonaPage

2 minute readReference

addPageToPersonaCategory

Adds a persona page to a given category.

Arguments

Argument Name Type Description

personaCategoryName

String

The persona category name.(Required)

personaPageName

String

The persona page name.(Required)

afterPage

String

If specified, the page will be placed after the named page.

beforePage

String

If specified, the page will be placed before the named page.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.addPageToPersonaCategory(
                personaCategoryName: 'test-personaCategoryName',
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

addPersonaSubpage

Adds one or more persona subpage to a given page.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

personaPages

String array

A list of subpages.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.addPersonaSubpage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

createPersonaPage

Create a new persona page.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

subpages

String array

A list of subpages.

url

String

The persona page URL.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createPersonaPage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

deletePersonaPage

Deletes the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

force

Boolean

If true persona page is force removed.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deletePersonaPage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

getPersonaPage

Retrieves the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaPage(
                personaPageName: 'test-personaPageName')

getPersonaPages

Retrieves all persona pages.

Arguments

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getPersonaPages()

modifyPersonaPage

Modifies the specified personaPage object.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

newName

String

The new name for an existing object that is being renamed.

subpages

String array

A list of subpages.

url

String

The persona page URL.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyPersonaPage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)

removePersonaSubpage

Deletes a persona subpage.

Arguments

Argument Name Type Description

personaPageName

String

The persona page name.(Required)

personaPages

String array

A list of subpages.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.removePersonaSubpage(
                personaPageName: 'test-personaPageName'
                /* optional arguments */)