new({ProjectParamsHashRef})
Sync()
GetEnvironment()
Clobber()
Fire({EnvHashRef},{ClassName})
Create(From)
AddStep(Step)
UpdateStep(Step,MoveToHashRef)
DeleteStep(Step)
AddTagVar(TagVar)
DeleteTagVar(TagVar)
GetLastError()
GetLastMessage()
StepList()
AddRegister(Register)
DeleteRegister(Register)
RegisterList()
TagVarList()
Sync()
BuildForge::API::Project
my $Project = new BuildForge::API::Project(); $Project->{'title'} = "My New Project"; $Project->Create();
This is available to use after a BuildForge::API object has been instantiated. It is used to create new BuildForge Projects, and to access existing project information.
new({ProjectParamsHashRef})
Create an object to access existing project information or to add a new project to the BuildForge console.
Sync()
Populates the Project object with data from the BF Console. Requires either Project 'title' or 'project_id' to be set.
GetEnvironment()
Returns a BuildForge::API::Environ object representing the Project Environment. Requires either Project 'title' or 'project_id' to be set.
Clobber()
Clobbers the project from the management console. The project, all steps, all builds, and all log data are removed. Use with caution. Requires either Project 'title' or 'project_id' to be set.
Fire({EnvHashRef},{ClassName})
Starts a build of the Project. Requires either Project 'title' or 'project_id' to be set. Returns the internal Build ID of the started build.
Fire()
with a hashref that contains PATH information,
both PATH variables will be appended to the projects running path.
Create(From)
Create a new Project inside BuildForge. Requires Project 'title' to be set. The optional From parameter allows you to use an existing Project as a template. All settings except the project title will then be taken from the source project.
AddStep(Step)
Adds a step to an existing Project. Requires either Project 'title' or 'project_id' to be set.
UpdateStep(Step,MoveToHashRef)
Updates a Project Step, and optionally allows you to change its location.
DeleteStep(Step)
Deletes a step from a Project. Requires either Project 'title' or 'project_id' to be set.
AddTagVar(TagVar)
Adds a tag variable to project. Requires either Project 'title' or 'project_id' to be set.
DeleteTagVar(TagVar)
Deletes a tag variable from a project. Requires either Project 'title' or 'project_id' to be set.
GetLastError()
Returns the last error code encountered by the object.
GetLastMessage()
Returns an last message string encountered by the object.
StepList()
Returns an array ref of hash refs containing step details. Requires either Project 'title' or 'project_id' to be set.
AddRegister(Register)
Add a Register entry to the Project. Requires either Project 'title' or 'project_id' to be set.
DeleteRegister(Register)
Deletes a register from the Project. Requires either Project 'title' or 'project_id' to be set.
RegisterList()
Returns an array ref of hash refs containing register details. Requires either Project 'title' or 'project_id' to be set.
TagVarList()
Returns an array ref of hash refs containing tag variable details. Requires either Project 'title' or 'project_id' to be set.
Sync()
Syncs the object with information from the console database. Requires either Project 'title' or 'project_id' to be set.
BuildForge, Inc.