Class: Asana::Resources::EventsBase

Inherits:
Resource
  • Object
show all
Defined in:
lib/asana/resources/gen/events_base.rb

Direct Known Subclasses

EventResponse

Class Method Summary collapse

Methods inherited from Resource

#initialize, #method_missing, #refresh, #respond_to_missing?, #to_h, #to_s

Methods included from ResponseHelper

#parse

Constructor Details

This class inherits a constructor from Asana::Resources::Resource

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Asana::Resources::Resource

Class Method Details

.get_events(client, resource: nil, sync: nil, options: {}) ⇒ Object

resource - [str] (required) A resource ID to subscribe to. The resource can be a task or project.

Parameters:

  • sync (str) (defaults to: nil)

    A sync token received from the last request, or none on first sync. Events will be returned from the point in time that the sync token was generated. *Note: On your first request, omit the sync token. The response will be the same as for an expired sync token, and will include a new valid sync token.If the sync token is too old (which may happen from time to time) the API will return a `412 Precondition Failed` error, and include a fresh sync token in the response.*

  • options (Hash) (defaults to: {})

    the request I/O options

  • list (>str)

    ] Defines fields to return. Some requests return compact representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.

  • bool (>])

    opt_pretty [bool] Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.


23
24
25
26
27
# File 'lib/asana/resources/gen/events_base.rb', line 23

def get_events(client, resource: nil, sync: nil, options: {})
  path = "/events"
  params = { resource: resource, sync: sync }.reject { |_,v| v.nil? || Array(v).empty? }
  Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
end

.inherited(base) ⇒ Object


10
11
12
# File 'lib/asana/resources/gen/events_base.rb', line 10

def self.inherited(base)
  Registry.register(base)
end