Working With Checklists

In this article we describe the methods used to manipulate Checklists in activeCollab.

object ActiveCollab::findChecklistById(int $project_id, int $checklist_id) - Fetches an ActiveCollabChecklist object

Parameters:

project_id - id of the project where the checklist is located checklist_id - id of a specific checklist

Return value: Object instance of ActiveCollabChecklist

object $checklist = new ActiveCollabChecklist(int $project_id) - Creates new ActiveCollabChecklist object

Parameters:

project_id - id of the project in which the checklist is going to be created

Variable value: Object instance of ActiveCollabChecklist

These methods are called out through an checklist object.

•   setCreatedByEmail(string $email)  -  Sets an email of the user who created this checklist
•   setCreatedByName(string $name)  -  Sets the name of the user who created this checklist
•   setName(string $name)  -  Sets the name of this checklist
•   setBody(string $body)  -  Sets the description of this checklist
•   setTags(array of string $tagArr) - Sets tags for this checklist
•   setVisibility(int $visibility) - Sets the visibility of this checklist; the visibility parameter can be a combination of the following constants: ACTIVECOLLAB_VISIBILITY_PRIVATE, ACTIVECOLLAB_VISIBILITY_NORMAL
•   setMilestoneId(int $milestone_id) - Sets the milestone for this checklist
•   save(void) - Saves the checklist object into activeCollab