NAME

BuildForge::API::Environ


SYNOPSIS

        my $Environ = new BuildForge::API::Environ();
        $Environ->{'name'} = "New Env Group";
        $Environ->Create();


DESCRIPTION

    This is available to use after a BuildForge::API object has been
instantiated. It is used to create, delete and modify environment groups
and variables.


METHODS

new({EnvironParamsHashRef})

Create an object to access existing environment information, or to add a new environment group to the BuildForge console.

name
The title of this env group

access_group_id
The controlled access to this group

Create(From)

Creates a new environment group. Requires the 'name' object property to be set.

From
A BuildForge::API::Environ object.

Delete()

Deletes the environment group. Requires either the 'group_id' or 'name' to be set.

AddVariable({VariableParamsHashRef})

Adds a new variable to the environment group. Requires the object 'name' to be set, and the 'name' key to be set in the VariableParamsHashRef.

name
The name of the variable you with to create

value
The initial value for the variable

action
(S/N/A/P/C/U/H)
: S = Assign As
: N = Assign If Not Assigned
: A = Append Existing
: P = Prepend Existing
: C = Clear Existing
: U = Delete Variable
: H = Assign Hidden
on_project
(N/R/O/S/C)
: N = Normal
: R = Required
: O = Read-Only
: S = Suppress Display
: C = Must Change

DeleteVariable({VariableParamsHashRef})

Deletes a variable from the environment group. Requires the objects 'name' parameter to be set, and the 'name' key of the VariableParamsHashRef to be set.

name
The name of the variable you with to delete

VariableList()

Returns a list ref of hash refs containing information about the variables, values and settings of each entry in the Environment Group. Requires the objects 'group_id' or 'name' to be set.

Sync()

Syncs the object with information from the console database. Requires the objects 'group_id' or 'name' to be set.


AUTHOR

BuildForge, Inc.