Class: LWS::Presence::Person

Inherits:

Generic::Model

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

Defined in:

lib/lws/apps/presence.rb

Overview

The person class

Instance Attribute Summary

• #address ⇒ String^?

  The address of the person.

• #appointments ⇒ Array<Appointment>

  The appointments involving the person.

• #avatar_storage_id ⇒ String^?

  The storage ID of the avatar of the person.

• #avatar_url ⇒ String^?

  The URL of the avatar of the person.

• #birthdate ⇒ String^?

  The birthdate of the person.

• #city ⇒ String^?

  The city of the person.

• #company ⇒ LWS::Auth::Company

  The company the person belongs to.

• #company_id ⇒ Integer

  The ID of the company the person belongs to.

• #company_name ⇒ String

  The name of the company the person works for.

• #country ⇒ String^?

  The country of the person.

• #customer_reference ⇒ String^?

  The customer specific reference for the person.

• #email ⇒ String^?

  The email address of the person.

• #ero ⇒ Boolean

  Whether the person is emergency response ceritified.

• #extra_info ⇒ String^?

  Some extra info for the person.

• #import_ref ⇒ String^?

  Reference of the person in the remote database.

• #kind ⇒ "employee", "guest"

  The person kind.

• #last_sync ⇒ String^?

  The last date/time the status was updated via a device or RFID tag.

• #lat ⇒ Float^?

  The exact latitude of the person’s location.

• #location ⇒ Location

  The location the person is located at.

• #location_ancestors_ids ⇒ Array<Integer>

  The IDs of the (nesting) locations the person is located at.

• #location_id ⇒ Integer

  The ID of the location the person is located at.

• #location_status_change_permissions ⇒ Array<"available", "unavailable", "maintenance_cleaning", "maintenance_technical", "permanent_available", "permanent_unavailable", "permanent_maintenance_cleaning", "permanent_maintenance_technical">

  The location statuses the person will clear to available on check-in.

• #long ⇒ Float^?

  The exact longitude of the person’s location.

• #name ⇒ String

  The name of the person.

• #people_responsible_for ⇒ Array<Person>

  The people the person is responsible for.

• #person_responsible ⇒ Person^?

  The person responsible for this person.

• #person_responsible_id ⇒ Integer^?

  The ID of the person responsible for this person.

• #phone_extension ⇒ String

  The fixed phonenumber extension of the person.

• #phone_fixed ⇒ String

  The fixed phonenumber of the person.

• #phone_mobile ⇒ String

  The mobile phonenumber of the person.

• #picture_url ⇒ String^? deprecated Deprecated.

  Unauthenticated retrieval of the picture will not longer be supported in upcoming releases of LWS. Use #avatar_url instead!

• #present ⇒ Boolean

  If a person is present at a location.

• #rfid ⇒ String^?

  The RFID tag ID linked to the person.

• #status ⇒ "available", ...

  The presence status of the person.

• #udid ⇒ String^?

  The unique device ID (e.g. of a mobile phone) linked to the person.

• #vehicle_registration_plate ⇒ String^?

  The vehicle registration plate of the persons transport.

• #visibility ⇒ "public", "private"

  If a person should be protected by not showing critical information.

• #zip_code ⇒ String^?

  The zip code of the person.

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

#address ⇒ String^?

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

attribute :address

#appointments ⇒ Array<Appointment>

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

has_many :appointments

#avatar_storage_id ⇒ String^?

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

attribute :avatar_storage_id

#avatar_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 avatar of the person.

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

attribute :avatar_url

#birthdate ⇒ String^?

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

attribute :birthdate

#city ⇒ String^?

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

attribute :city

#company ⇒ LWS::Auth::Company

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

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

#company_id ⇒ Integer

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

attribute :company_id

#company_name ⇒ String

Note:

This is not the name of the company the person belongs to, but possibly a guest/visitor working for another company!

Returns the name of the company the person works for.

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

attribute :company_name

#country ⇒ String^?

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

attribute :country

#customer_reference ⇒ String^?

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

attribute :customer_reference

#email ⇒ String^?

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

attribute :email

#ero ⇒ Boolean

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

attribute :ero

#extra_info ⇒ String^?

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

attribute :extra_info

#import_ref ⇒ String^?

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

attribute :import_ref

#kind ⇒ "employee", "guest"

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

attribute :kind

#last_sync ⇒ String^?

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

attribute :last_sync

#lat ⇒ Float^?

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

attribute :lat

#location ⇒ Location

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

belongs_to :location

#location_ancestors_ids ⇒ Array<Integer>

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

attribute :location_ancestor_ids

#location_id ⇒ Integer

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

attribute :location_id

#location_status_change_permissions ⇒ Array<"available", "unavailable", "maintenance_cleaning", "maintenance_technical", "permanent_available", "permanent_unavailable", "permanent_maintenance_cleaning", "permanent_maintenance_technical">

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

attribute :location_status_change_permissions

#long ⇒ Float^?

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

attribute :long

#name ⇒ String

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

attribute :name

#people_responsible_for ⇒ Array<Person>

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

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

#person_responsible ⇒ Person^?

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

belongs_to :person_responsible, class_name: "LWS::Presence::Person",
foreign_key: "person_responsible_id",
uri: "people/:id"

#person_responsible_id ⇒ Integer^?

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

attribute :person_responsible_id

#phone_extension ⇒ String

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

attribute :phone_extension

#phone_fixed ⇒ String

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

attribute :phone_fixed

#phone_mobile ⇒ String

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

attribute :phone_mobile

#picture_url ⇒ String^?

Deprecated.

Unauthenticated retrieval of the picture will not longer be supported in upcoming releases of LWS. Use #avatar_url instead!

Returns the URL of the picture of the person.

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

attribute :picture_url

#present ⇒ Boolean

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

attribute :present

#rfid ⇒ String^?

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

attribute :rfid

#status ⇒ "available", ...

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

attribute :status

#udid ⇒ String^?

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

attribute :udid

#vehicle_registration_plate ⇒ String^?

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

attribute :vehicle_registration_plate

#visibility ⇒ "public", "private"

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

attribute :visibility

#zip_code ⇒ String^?

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

attribute :zip_code