basecampcfc.cfc.basecamp
Component basecamp

hierarchy:	WEB-INF.cftags.component basecampcfc.cfc.basecamp
properties:
Public methods:	createComment createMessage deleteComment deleteMessage getComment getCommentsByMessage getCompany getCompanyList getFileCategories getMessage getMessageArchive getMessageArchiveByCategory getMessageCategories getMileStoneList getPeopleByCompany getPeopleByProject getPerson getProject getProjectList getToDo getToDoList init updateComment updateMessage
Private methods:	convertBaseCampDateTime* convertBasecampXMLToQuery* convertPostRequestToXML* makeHTTPGetRequest* makeHTTPPostRequest* returnAllSubKeys*

* - private method

Public Methods

createComment
`public query createComment ( required string messageID, required string body )` Creates a comment in a Basecamp project. Output: suppressed Parameters: messageID: string, required, messageID - The message in which to post comment. body: string, required, body - The body of the message.
createMessage
`public query createMessage ( required string projectID, required string title, required string body, string extended_body="", boolean private="TRUE", boolean use_textile="FALSE", required string categoryID, array notifyArray )` Creates a message in a Basecamp project. Output: suppressed Parameters: projectID: string, required, projectID - The project in which to post the message. title: string, required, title - The title of the message. body: string, required, body - The body of the message. extended_body: string, optional, extended_body - The extended body of the message. private: boolean, optional, private - Whether or not the message should be shared with clients. use_textile: boolean, optional, use_textile - Whether or not the message should be shared with clients. categoryID: string, required, categoryID - The category in which to post message. notifyArray: array, optional, notifyArray - An array of people (personID) to notify about the message.
deleteComment
`public query deleteComment ( required string commentID )` Deletes a comment from a Basecamp project. Output: suppressed Parameters: commentID: string, required, commentID - The comment to Delete.
deleteMessage
`public query deleteMessage ( required string messageID )` Deletes a message from a Basecamp project. Output: suppressed Parameters: messageID: string, required, messageID - The message to Delete.
getComment
`public query getComment ( required string commentID )` Gets a specific comment. Output: suppressed Parameters: commentID: string, required, commentID - The Basecamp comment to retrieve.
getCommentsByMessage
`public query getCommentsByMessage ( required string messageID )` Gets all comments for a given message. Output: suppressed Parameters: messageID: string, required, messageID - The Basecamp message for which to retrieve messages
getCompany
`public query getCompany ( required string companyID )` Gets the details of one company. Output: suppressed Parameters: companyID: string, required, companyID - The id of a company for which to retrieve details.
getCompanyList
`public query getCompanyList ( )` Gets a list of companies. Output: suppressed
getFileCategories
`public query getFileCategories ( required string projectID )` Gets a list of all of the file categories for a project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details.
getMessage
`public query getMessage ( required string messageID )` Gets a single message. Output: suppressed Parameters: messageID: string, required, messageID - The Basecamp message to get.
getMessageArchive
`public query getMessageArchive ( required string projectID )` Gets the list of all messages for a project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get messages.
getMessageArchiveByCategory
`public query getMessageArchiveByCategory ( required string projectID, required string categoryID )` Gets the list of all messages for a project by categoryID. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get messages. categoryID: string, required, categoryID - The category for which to get messages.
getMessageCategories
`public query getMessageCategories ( required string projectID )` Gets a list of all of the message categories for a project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details.
getMileStoneList
`public query getMileStoneList ( required string projectID )` Gets all of the milestones for a project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details.
getPeopleByCompany
`public query getPeopleByCompany ( required string companyID )` Gets a list of people per a company. Output: suppressed Parameters: companyID: string, required, companyID - The id of a company for which to retrieve people.
getPeopleByProject
`public query getPeopleByProject ( required string projectID, required string companyID )` Gets a list of people per a proejct. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details. companyID: string, required, companyID - The id of a company for which to retrieve people.
getPerson
`public query getPerson ( required string personID, boolean obscurePassword="true" )` Gets information about a person. Output: suppressed Parameters: personID: string, required, personID - The Basecamp person to retrieve obscurePassword: boolean, optional, obscurePassword - Obscures the password instead of displaying it.
getProject
`public query getProject ( required string projectID )` Gets the the details of one project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details.
getProjectList
`public query getProjectList ( )` Get list of all projects in Basecamp Account. Output: suppressed
getToDo
`public query getToDo ( required string todoListID )` Gets a todo list. Output: suppressed Parameters: todoListID: string, required, todoListID - The todo list for which to get details.
getToDoList
`public query getToDoList ( required string projectID )` Gets all of the todo lists for a project. Output: suppressed Parameters: projectID: string, required, projectID - The Basecamp project for which to get details.
init
`public any init ( required string basecampUrl, required string username, required string password )` This is the pseudo constructor that allows us to play little object games. Output: suppressed Parameters: basecampUrl: string, required, basecampUrl - The Basecamp Username to use. username: string, required, username - The Basecamp Username to use. password: string, required, password - The Basecamp Username to use.
updateComment
`public query updateComment ( required string commentID, required string body )` Updates a comment in a Basecamp project. Output: suppressed Parameters: commentID: string, required, commentID - The comment to update. body: string, required, body - The new body of the message.
updateMessage
`public query updateMessage ( required string messageID, string title, string body, string extended_body, boolean private, boolean use_textile, string categoryID, array notifyArray )` Updates a message in a Basecamp project. Output: suppressed Parameters: messageID: string, required, messageID - The message to Update. title: string, optional, title - The title of the message. body: string, optional, body - The body of the message. extended_body: string, optional, extended_body - The extended body of the message. private: boolean, optional, private - Whether or not the message should be shared with clients. use_textile: boolean, optional, use_textile - Whether or not the message should be shared with clients. categoryID: string, optional, categoryID - The category in which to post message. notifyArray: array, optional, notifyArray - An array of people (personID) to notify about the message.

Private Methods

convertBaseCampDateTime*
`private date convertBaseCampDateTime ( required string baseCampTime="" )` Converts BaseCamp time to a ColdFusion date time variable. Output: suppressed Parameters: baseCampTime: string, required, baseCampTime - The basecamp formatted date time.
convertBasecampXMLToQuery*
`private query convertBasecampXMLToQuery ( required XML basecampXML, required string collection, string root="" )` Converts the results from Basecamp into an ColdFusion query variable. Output: suppressed Parameters: basecampXML: XML, required, basecampXML - The Basecamp XML content. collection: string, required, collection - The name of the collection to loop over. If the xml structure is 'basecampxml.comments.comment',we are looking for 'comment'. root: string, optional, root - The root of the XML file, needed if collection is not the root.
convertPostRequestToXML*
`private string convertPostRequestToXML ( required struct request="" )` Takes a post request structure and converts it to the XML form that Basecamp needs. Output: suppressed Parameters: request: struct, required, request - The request structure to transform.
makeHTTPGetRequest*
`private XML makeHTTPGetRequest ( required string urlToRequest="" )` Encapsulates getting the requesting and parsing the Basecamp results into an XML variable. Output: suppressed Parameters: urlToRequest: string, required, urlToRequest - The url to request the data from.
makeHTTPPostRequest*
`private XML makeHTTPPostRequest ( required string urlToRequest, struct request )` Encapsulates getting the requesting and parsing the Basecamp results into an XML variable. Output: suppressed Parameters: urlToRequest: string, required, urlToRequest - The url to request the data from. request: struct, optional, request - A structured post to send to Basecamp API. Usually for creating items.
returnAllSubKeys*
`private array returnAllSubKeys ( required any array )` Takes an Array of structures, and returns a list of all keys. Output: suppressed Parameters: array: any, required, array - The array of structures to parse.