Module: Readmill::Client::Locations

Included in:

Readmill::Client

Defined in:

lib/readmill/client/locations.rb

Overview

Public: This module will bring all of the methods from the location section of the API.

Instance Method Summary

• #locations(reading_id, opts = {}) ⇒ Object

  Public: Get locations for a reading from readmill.

Instance Method Details

#locations(reading_id, opts = {}) ⇒ Object

Public: Get locations for a reading from readmill.

reading_id - An id of the reading to get locations for. opts - A Hash of options used to modify the results. All of the

values of this Hash will be forwarded to the API as
parameters (default: {}).

Returns an Array.

# File 'lib/readmill/client/locations.rb', line 16

def locations(reading_id, opts={})
  get("readings/#{reading_id}/locations", opts).items
end