class Projects::Api::EventsAPI

Public Class Methods

new(authToken,portalId) click to toggle source
  • Construct a new EventsAPI 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/EventsAPI.rb, line 36
def initialize(authToken,portalId)
        super(authToken,portalId)
end

Public Instance Methods

add(projectId, event) click to toggle source
  • Add an event for the project.

Parameters

  • projectId
    • ID of the project.

  • event
    • Event object.

Returns

  • Event object.

# File lib/projects/api/EventsAPI.rb, line 72
def add(projectId, event)
        url = getBaseURL+"projects/"+String(projectId)+"/events/"           
        response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)          
        return $eventParser.getEvent(response)
end
delete(projectId, eventId) click to toggle source
  • Delete an existing event for the project.

Parameters

  • projectId
    • ID of the project.

  • eventId
    • ID of the event.

Returns

  • String object.

# File lib/projects/api/EventsAPI.rb, line 108
def delete(projectId, eventId)
        url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(eventId)+"/"               
        response = ZohoHTTPClient.delete(url, getQueryMap)
        return $eventParser.getResult(response)
end
getEvents(projectId, queryMap) click to toggle source
  • Get list of events for the project.

Parameters

  • projectId
    • ID of the project.

  • queryMap
    • This queryMap contains the filters in the form of key-value pair.

Returns

  • List of Event object.

# File lib/projects/api/EventsAPI.rb, line 53
def getEvents(projectId, queryMap)
        url = getBaseURL+"projects/"+String(projectId)+"/events/"           
        response = ZohoHTTPClient.get(url, getQueryMap(queryMap))   
        return $eventParser.getEvents(response)
end
update(projectId, event) click to toggle source
  • Update the details of an event.

Parameters

  • projectId
    • ID of the project.

  • event
    • Event object.

Returns

  • Event object.

# File lib/projects/api/EventsAPI.rb, line 90
def update(projectId, event)
        url = getBaseURL+"projects/"+String(projectId)+"/events/"+String(event.getId)+"/"           
        response = ZohoHTTPClient.post(url, getQueryMap, event.toParamMAP)          
        return $eventParser.getEvent(response)
end