import Bundles from 'opengate-js/src/bundles/Bundles.js'

public class | source

Bundles

Extends:

BaseProvision → Bundles

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	activate(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function activates a bundle
public	addDeploymentElement(progressEvent: *): DeploymentElement Create deployment element that is asociated to the Bundle
public	create(): Promise Creates a new bundle
public	deactivate(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deactivates a bundle
public	deployAndActivate(): DeploymentElement Deploy all elements of a bundle in only one method
public	update(): Promise Updates a bundle
public	withActive(active: string): Bundles Set the active attribute
public	withDescription(description: string): Bundles Set the description attribute
public	withHardware(hardware: string): Bundles Set the hardware attribute
public	withName(name: string): Bundles Set the name attribute
public	withPostaction(postactions: string): Bundles Set the postactions attribute
public	withPreaction(preaction: string): Bundles Set the preaction attribute
public	withTimeout(ms: number): Bundles The request will have a specific time out if it will be exceeded then the promise throw an exception
public	withUserNotes(userNotes: string): Bundles Set the userNotes attribute
public	withVersion(version: string): Bundles Set the version attribute
public	withWorkgroup(workgroup: string): Bundles Set the workgroup attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public activate(): Promise source

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

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

Example:

 ogapi.bundlesBuilder().activate()

public addDeploymentElement(progressEvent: *): DeploymentElement source

Create deployment element that is asociated to the Bundle

Params:

Name	Type	Attribute	Description
progressEvent	*

Return:

DeploymentElement

Example:

 ogapi.bundlesBuilder().newDeploymentElement()

public create(): Promise source

Creates a new bundle

Override:

BaseProvision#create

Return:

Promise

Example:

 ogapi.bundlesBuilder().create()

public deactivate(): Promise source

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

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

Example:

 ogapi.bundlesBuilder().deactivate()

public deployAndActivate(): DeploymentElement source

Deploy all elements of a bundle in only one method

Return:

DeploymentElement

Example:

 ogapi.bundlesBuilder().deployAndActivate()

public update(): Promise source

Updates a bundle

Override:

BaseProvision#update

Return:

Promise

Example:

 ogapi.bundlesBuilder().update()

public withActive(active: string): Bundles source

Set the active attribute

Params:

Name	Type	Attribute	Description
active	string

Return:

Bundles

public withDescription(description: string): Bundles source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

Bundles

public withHardware(hardware: string): Bundles source

Set the hardware attribute

Params:

Name	Type	Attribute	Description
hardware	string

Return:

Bundles

public withName(name: string): Bundles source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Bundles

public withPostaction(postactions: string): Bundles source

Set the postactions attribute

Params:

Name	Type	Attribute	Description
postactions	string

Return:

Bundles

public withPreaction(preaction: string): Bundles source

Set the preaction attribute

Params:

Name	Type	Attribute	Description
preaction	string

Return:

Bundles

public withTimeout(ms: number): Bundles source

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

Params:

Name	Type	Attribute	Description
ms	number		timeout in milliseconds

Return:

Bundles

public withUserNotes(userNotes: string): Bundles source

Set the userNotes attribute

Params:

Name	Type	Attribute	Description
userNotes	string

Return:

Bundles

public withVersion(version: string): Bundles source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string

Return:

Bundles

public withWorkgroup(workgroup: string): Bundles source

Set the workgroup attribute

Params:

Name	Type	Attribute	Description
workgroup	string

Return:

Bundles