class Projects::Api::FoldersAPI

Public Class Methods

new(authToken,portalId) click to toggle source
  • Construct a new FoldersAPI using User's authToken and portalId.

Parameters

  • authToken
    • User's authToken.

  • portalId
    • User's portalId.

Calls superclass method Projects::Api::API::new
# File lib/projects/api/FoldersAPI.rb, line 36
def initialize(authToken,portalId)
        super(authToken,portalId)
end

Public Instance Methods

addFolder(projectId, folder) click to toggle source
  • Add a folder for the project.

Parameters

  • projectId
    • ID of the project.

  • folder
    • Folder object.

Returns
  • Folder object.

# 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) click to toggle source
  • Delete an existing folder for the project.

Parameters

  • projectId
    • ID of the project.

  • folderId
    • ID of the folder.

Returns

  • String object.

# 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) click to toggle source
  • Get list of folders for the project.

Parameters

  • projectId
    • ID of the project.

Returns
  • List of Folder object.

# 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) click to toggle source
  • Update the details of a folder.

Parameters

  • projectId
    • ID of the project.

  • folder
    • Folder object.

Returns
  • Folder object.

# 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