Class: Projects::Api::FoldersAPI

Inherits:
API
  • Object
show all
Includes:
Parser, Util
Defined in:
lib/projects/api/FoldersAPI.rb

Instance Method Summary collapse

Methods inherited from API

#getBaseURL, #getQueryMap

Constructor Details

#initialize(authToken, portalId) ⇒ FoldersAPI

  • Construct a new FoldersAPI using User's authToken and portalId.

Parameters

* authToken
  • User's authToken.
* portalId
  • User's portalId.


36
37
38
 
# File 'lib/projects/api/FoldersAPI.rb', line 36

def initialize(authToken,portalId)
	super(authToken,portalId)
end

Instance Method Details

#addFolder(projectId, folder) ⇒ Object

  • Add a folder for the project.

Parameters

* projectId
  • ID of the project.
* folder
  • Folder object.
Returns
  • Folder object.


68
69
70
71
72
 
# File 'lib/projects/api/FoldersAPI.rb', line 68

def addFolder(projectId, folder)
	url = getBaseURL+"projects/"+String(projectId)+"/folders/"		
	response = ZohoHTTPClient.post(url, getQueryMap, folder.toParamMAP)		
	return $folderParser.getFolder(response)
end

#deleteFolder(projectId, folderId) ⇒ Object

  • String object.


104
105
106
107
108
 
# File 'lib/projects/api/FoldersAPI.rb', line 104

def deleteFolder(projectId, folderId)
	url = getBaseURL+"projects/"+String(projectId)+"/folders/"+String(folderId)+"/"	
	response = ZohoHTTPClient.delete(url, getQueryMap)		
	return $folderParser.getResult(response)
end

#getFolders(projectId) ⇒ Object

  • Get list of folders for the project.

Parameters

* projectId
  • ID of the project.
Returns
  • List of Folder object.


50
51
52
53
54
 
# File 'lib/projects/api/FoldersAPI.rb', line 50

def getFolders(projectId)
	url = getBaseURL+"projects/"+String(projectId)+"/folders/"		
	response = ZohoHTTPClient.get(url, getQueryMap)	
	return $folderParser.getFolders(response)
end

#updateFolder(projectId, folder) ⇒ Object

  • Update the details of a folder.

Parameters

* projectId
  • ID of the project.
* folder
  • Folder object.
Returns
  • Folder object.


86
87
88
89
90
 
# File 'lib/projects/api/FoldersAPI.rb', line 86

def updateFolder(projectId, folder)
	url = getBaseURL+"projects/"+String(projectId)+"/folders/"+String(folder.getId)+"/"		
	response = ZohoHTTPClient.post(url, getQueryMap, folder.toParamMAP)	
	return $folderParser.getFolder(response)
end