Class: LWS::Presence::Location

Inherits:

Generic::Model

• Object
• Spyke::Base
• Generic::Model
• LWS::Presence::Location

Defined in:

lib/lws/apps/presence.rb

Overview

The location class

Defined Under Namespace

Classes: Map

Instance Attribute Summary

• #ancestor_ids ⇒ Array<Integer>

  The ID of the locations that containt the location, including the location itself.

• #appointments ⇒ Array<Appointment>

  The appointments taking place at the location.

• #capacity ⇒ Integer

  The capacity (maximum number of people) of the location.

• #capacity_tree ⇒ Integer

  The capacity (maximum number of people) of the location including descendant locations.

• #capacity_used ⇒ Integer

  The used capacity (present number of people) of the location.

• #capacity_used_percentage ⇒ Float

  The used capacity percentage of the location.

• #capacity_used_percentage_tree ⇒ Float

  The used capacity percentage of the location including descendant locations.

• #capacity_used_tree ⇒ Integer

  The used capacity (present number of people) of the location including descendant locations.

• #checkin_status ⇒ "available", ...

  The presence status to set people to when checking in.

• #checkout_alter_status ⇒ "available", ...

  The status to set the location to when someone checks out.

• #checkout_location ⇒ Location^?

  The location to move people to when they are checked out.

• #checkout_location_id ⇒ Integer^?

  The ID of the location to move people to when they are checked out.

• #company ⇒ LWS::Auth::Company

  The company the location belongs to.

• #company_id ⇒ Integer

  The ID of the company the location belongs to.

• #descendant_ids ⇒ Array<Integer>

  The IDs of the underlying locations of the location.

• #image_storage_id ⇒ String^?

  The storage ID of the image of the location.

• #image_url ⇒ String^?

  The URL of the image of the location.

• #journals ⇒ Array<Journal>

  The journal (entries) associated with the location.

• #lat ⇒ Float

  The latitude of the location.

• #logoff_time ⇒ String

  The format of the time is HH:MM and should be interpreted in the time zone of the location (see also #time_zone).

• #long ⇒ Float

  The longitude of the location.

• #map_positions ⇒ Array<Location::Map::Position>

  The location map positions that track this location.

• #maps ⇒ Array<Location::Map>

  The maps for this location.

• #name ⇒ String

  The name of the location.

• #owner ⇒ Person^?

  The owner of the location.

• #owner_id ⇒ Fixnum^?

  The ID of the owner of the location.

• #parent ⇒ Location

  The parent of the location.

• #parent_id ⇒ Integer

  The ID of the parent of the location.

• #people ⇒ Array<Person>

  The people associated with the location.

• #people_tree ⇒ Array<Person>

  The people associated with the location including descendant locations.

• #range ⇒ Integer

  The range around the location in meters.

• #readers ⇒ Array<Reader>

  The (RFID/code/ID/…) readers linked to this location.

• #status ⇒ "available", ...

  The status of the location.

• #time_zone ⇒ String

  The time zone of the location.

• #uuid ⇒ String

  The UUID of the location.

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#deep_dup, #dig, #reload, #rollback, #save

Instance Attribute Details

#ancestor_ids ⇒ Array<Integer>

# File 'lib/lws/apps/presence.rb', line 138

attribute :ancestor_ids

#appointments ⇒ Array<Appointment>

# File 'lib/lws/apps/presence.rb', line 142

has_many :appointments

#capacity ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 146

attribute :capacity

#capacity_tree ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 151

attribute :capacity_tree

#capacity_used ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 155

attribute :capacity_used

#capacity_used_percentage ⇒ Float

# File 'lib/lws/apps/presence.rb', line 164

attribute :capacity_used_precentage

#capacity_used_percentage_tree ⇒ Float

# File 'lib/lws/apps/presence.rb', line 169

attribute :capacity_used_precentage_tree

#capacity_used_tree ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 160

attribute :capacity_used_tree

#checkin_status ⇒ "available", ...

# File 'lib/lws/apps/presence.rb', line 174

attribute :checkin_status

#checkout_alter_status ⇒ "available", ...

# File 'lib/lws/apps/presence.rb', line 182

attribute :checkout_alter_status

#checkout_location ⇒ Location^?

# File 'lib/lws/apps/presence.rb', line 187

belongs_to :checkout_location, class_name: "LWS::Presence::Location",
foreign_key: "checkout_location_id",
uri: "locations/:id"

#checkout_location_id ⇒ Integer^?

# File 'lib/lws/apps/presence.rb', line 194

attribute :checkout_location_id

#company ⇒ LWS::Auth::Company

# File 'lib/lws/apps/presence.rb', line 198

belongs_to :company, class_name: "LWS::Auth::Company"

#company_id ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 202

attribute :company_id

#descendant_ids ⇒ Array<Integer>

# File 'lib/lws/apps/presence.rb', line 206

attribute :descendant_ids

#image_storage_id ⇒ String^?

# File 'lib/lws/apps/presence.rb', line 210

attribute :image_storage_id

#image_url ⇒ String^?

Note:

To be able retrieve this, the token needs to be passed via X-Token in the HTTP request headers!

Returns the URL of the image of the location.

# File 'lib/lws/apps/presence.rb', line 217

attribute :image_url

#journals ⇒ Array<Journal>

# File 'lib/lws/apps/presence.rb', line 221

has_many :journals, class: "LWS::Presence::Journal"

#lat ⇒ Float

# File 'lib/lws/apps/presence.rb', line 225

attribute :lat

#logoff_time ⇒ String

The format of the time is HH:MM and should be interpreted in the time zone of the location (see also #time_zone).

# File 'lib/lws/apps/presence.rb', line 231

attribute :logoff_time

#long ⇒ Float

# File 'lib/lws/apps/presence.rb', line 235

attribute :long

#map_positions ⇒ Array<Location::Map::Position>

# File 'lib/lws/apps/presence.rb', line 240

has_many :map_positions, class_name: "LWS::Presence::Location::Map::Position"

#maps ⇒ Array<Location::Map>

# File 'lib/lws/apps/presence.rb', line 244

has_many :maps, class_name: "LWS::Presence::Location::Map"

#name ⇒ String

# File 'lib/lws/apps/presence.rb', line 248

attribute :name

#owner ⇒ Person^?

# File 'lib/lws/apps/presence.rb', line 252

belongs_to :owner, class_name: "LWS::Presence::Person",
foreign_key: "owner_id",
uri: "people/:id"

#owner_id ⇒ Fixnum^?

# File 'lib/lws/apps/presence.rb', line 258

attribute :owner_id

#parent ⇒ Location

# File 'lib/lws/apps/presence.rb', line 262

belongs_to :parent, class_name: "LWS::Presence::Location",
foreign_key: "parent_id",
uri: "locations/:id"

#parent_id ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 268

attribute :parent_id

#people ⇒ Array<Person>

# File 'lib/lws/apps/presence.rb', line 272

has_many :people

#people_tree ⇒ Array<Person>

# File 'lib/lws/apps/presence.rb', line 277

has_many :people_tree, class_name: "LWS::Presence::Person"

#range ⇒ Integer

# File 'lib/lws/apps/presence.rb', line 281

attribute :range

#readers ⇒ Array<Reader>

# File 'lib/lws/apps/presence.rb', line 285

has_many :readers

#status ⇒ "available", ...

# File 'lib/lws/apps/presence.rb', line 292

attribute :status

#time_zone ⇒ String

# File 'lib/lws/apps/presence.rb', line 296

attribute :time_zone

#uuid ⇒ String

# File 'lib/lws/apps/presence.rb', line 300

attribute :uuid