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 collapse
-
#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.
-
#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.
-
#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 for storing the uid of 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.
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
#appointments ⇒ Array<Appointment>
Returns the appointments involving the person.
400 |
# File 'lib/lws/apps/presence.rb', line 400 has_many :appointments |
#avatar_storage_id ⇒ String?
Returns the storage ID of the avatar of the person.
404 |
# File 'lib/lws/apps/presence.rb', line 404 attribute :avatar_storage_id |
#avatar_url ⇒ String?
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.
411 |
# File 'lib/lws/apps/presence.rb', line 411 attribute :avatar_url |
#company ⇒ LWS::Auth::Company
Returns the company the person belongs to.
415 |
# File 'lib/lws/apps/presence.rb', line 415 belongs_to :company, class_name: "LWS::Auth::Company" |
#company_id ⇒ Integer
Returns the ID of the company the person belongs to.
419 |
# File 'lib/lws/apps/presence.rb', line 419 attribute :company_id |
#company_name ⇒ String
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.
426 |
# File 'lib/lws/apps/presence.rb', line 426 attribute :company_name |
#customer_reference ⇒ String?
Returns the customer specific reference for the person.
430 |
# File 'lib/lws/apps/presence.rb', line 430 attribute :customer_reference |
#email ⇒ String?
Returns the email address of the person.
434 |
# File 'lib/lws/apps/presence.rb', line 434 attribute :email |
#ero ⇒ Boolean
Returns whether the person is emergency response ceritified.
439 |
# File 'lib/lws/apps/presence.rb', line 439 attribute :ero |
#extra_info ⇒ String?
Returns some extra info for the person.
443 |
# File 'lib/lws/apps/presence.rb', line 443 attribute :extra_info |
#import_ref ⇒ String?
Returns reference for storing the uid of the remote database.
448 |
# File 'lib/lws/apps/presence.rb', line 448 attribute :import_ref |
#kind ⇒ "employee", "guest"
Returns the person kind.
452 |
# File 'lib/lws/apps/presence.rb', line 452 attribute :kind |
#last_sync ⇒ String?
Returns the last date/time the status was updated via a device or RFID tag.
457 |
# File 'lib/lws/apps/presence.rb', line 457 attribute :last_sync |
#lat ⇒ Float?
Returns the exact latitude of the person’s location.
461 |
# File 'lib/lws/apps/presence.rb', line 461 attribute :lat |
#location ⇒ Location
Returns the location the person is located at.
465 |
# File 'lib/lws/apps/presence.rb', line 465 belongs_to :location |
#location_ancestors_ids ⇒ Array<Integer>
Returns the IDs of the (nesting) locations the person is located at.
470 |
# File 'lib/lws/apps/presence.rb', line 470 attribute :location_ancestor_ids |
#location_id ⇒ Integer
Returns the ID of the location the person is located at.
474 |
# File 'lib/lws/apps/presence.rb', line 474 attribute :location_id |
#location_status_change_permissions ⇒ Array<"available", "unavailable", "maintenance_cleaning", "maintenance_technical", "permanent_available", "permanent_unavailable", "permanent_maintenance_cleaning", "permanent_maintenance_technical">
Returns the location statuses the person will clear to available on check-in.
482 |
# File 'lib/lws/apps/presence.rb', line 482 attribute :location_status_change_permissions |
#long ⇒ Float?
Returns the exact longitude of the person’s location.
486 |
# File 'lib/lws/apps/presence.rb', line 486 attribute :long |
#name ⇒ String
Returns the name of the person.
490 |
# File 'lib/lws/apps/presence.rb', line 490 attribute :name |
#people_responsible_for ⇒ Array<Person>
Returns the people the person is responsible for.
494 |
# File 'lib/lws/apps/presence.rb', line 494 has_many :people_responsible_for, class_name: "LWS::Presence::Person" |
#person_responsible ⇒ Person?
Returns the person responsible for this person.
498 499 500 |
# File 'lib/lws/apps/presence.rb', line 498 belongs_to :person_responsible, class_name: "LWS::Presence::Person", foreign_key: "person_responsible_id", uri: "people/:id" |
#person_responsible_id ⇒ Integer?
Returns the ID of the person responsible for this person.
504 |
# File 'lib/lws/apps/presence.rb', line 504 attribute :person_responsible_id |
#phone_extension ⇒ String
Returns the fixed phonenumber extension of the person.
508 |
# File 'lib/lws/apps/presence.rb', line 508 attribute :phone_extension |
#phone_fixed ⇒ String
Returns the fixed phonenumber of the person.
512 |
# File 'lib/lws/apps/presence.rb', line 512 attribute :phone_fixed |
#phone_mobile ⇒ String
Returns the mobile phonenumber of the person.
516 |
# File 'lib/lws/apps/presence.rb', line 516 attribute :phone_mobile |
#picture_url ⇒ String?
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.
523 |
# File 'lib/lws/apps/presence.rb', line 523 attribute :picture_url |
#present ⇒ Boolean
Returns if a person is present at a location. It looks at the state of a person so that local state checking is not needed.
529 |
# File 'lib/lws/apps/presence.rb', line 529 attribute :present |
#rfid ⇒ String?
Returns the RFID tag ID linked to the person.
533 |
# File 'lib/lws/apps/presence.rb', line 533 attribute :rfid |
#status ⇒ "available", ...
Returns the presence status of the person.
538 |
# File 'lib/lws/apps/presence.rb', line 538 attribute :status |
#udid ⇒ String?
Returns the unique device ID (e.g. of a mobile phone) linked to the person.
543 |
# File 'lib/lws/apps/presence.rb', line 543 attribute :udid |
#vehicle_registration_plate ⇒ String?
Returns The vehicle registration plate of the persons transport.
548 |
# File 'lib/lws/apps/presence.rb', line 548 attribute :vehicle_registration_plate |
#visibility ⇒ "public", "private"
Returns if a person should be protected by not showing critical information.
553 |
# File 'lib/lws/apps/presence.rb', line 553 attribute :visibility |