Bundles

Bundles

Bundles Objects

class Bundles()

This is a base object that contains all you can do about Bundles.

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
activate
function activate() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function activates a bundle

Returns:

  • Promise

Example:

 ogapi.bundlesBuilder().activate()
addDeploymentElement
function addDeploymentElement(progressEvent: *) -> 'DeploymentElement'

Create deployment element that is asociated to the Bundle

Arguments:

  • progressEvent *

Returns:

  • DeploymentElement

Example:

 ogapi.bundlesBuilder().newDeploymentElement()
create
function create() -> 'Promise'

Creates a new bundle

Returns:

  • Promise

Example:

 ogapi.bundlesBuilder().create()
deactivate
function deactivate() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises This function deactivates a bundle

Returns:

  • Promise

Example:

 ogapi.bundlesBuilder().deactivate()
deployAndActivate
function deployAndActivate() -> 'DeploymentElement'

Deploy all elements of a bundle in only one method

Returns:

  • DeploymentElement

Example:

 ogapi.bundlesBuilder().deployAndActivate()
update
function update() -> 'Promise'

Updates a bundle

Returns:

  • Promise

Example:

 ogapi.bundlesBuilder().update()
withActive
function withActive(active: string) -> 'Bundles'

Set the active attribute

Arguments:

  • active string

Returns:

  • Bundles
withDescription
function withDescription(description: string) -> 'Bundles'

Set the description attribute

Arguments:

  • description string

Returns:

  • Bundles
withHardware
function withHardware(hardware: string) -> 'Bundles'

Set the hardware attribute

Arguments:

  • hardware string

Returns:

  • Bundles
withName
function withName(name: string) -> 'Bundles'

Set the name attribute

Arguments:

  • name string - required field

Returns:

  • Bundles
withPostaction
function withPostaction(postactions: string) -> 'Bundles'

Set the postactions attribute

Arguments:

  • postactions string

Returns:

  • Bundles
withPreaction
function withPreaction(preaction: string) -> 'Bundles'

Set the preaction attribute

Arguments:

  • preaction string

Returns:

  • Bundles
withTimeout
function withTimeout(ms: number) -> 'Bundles'

The request will have a specific time out if it will be exceeded then the promise throw an exception

Arguments:

  • ms number - timeout in milliseconds

Returns:

  • Bundles
withUserNotes
function withUserNotes(userNotes: string) -> 'Bundles'

Set the userNotes attribute

Arguments:

  • userNotes string

Returns:

  • Bundles
withVersion
function withVersion(version: string) -> 'Bundles'

Set the version attribute

Arguments:

  • version string

Returns:

  • Bundles
withWorkgroup
function withWorkgroup(workgroup: string) -> 'Bundles'

Set the workgroup attribute

Arguments:

  • workgroup string

Returns:

  • Bundles