Class: LWS::Presence::Person

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/presence.rb

Overview

The person class

Instance Attribute Summary collapse

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?

Returns the address of the person.

Returns:

  • (String, nil) —

    the address of the person



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

attribute :address

#appointments ⇒ Array<Appointment>

Returns the appointments involving the person.

Returns:

  • (Array<Appointment>) —

    the appointments involving the person



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

has_many :appointments

#avatar_storage_id ⇒ String?

Returns the storage ID of the avatar of the person.

Returns:

  • (String, nil) —

    the storage ID of the avatar of the person



456
 
# 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.

Returns:

  • (String, nil) —

    the URL of the avatar of the person



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

attribute :avatar_url

#birthdate ⇒ String?

Returns the birthdate of the person.

Returns:

  • (String, nil) —

    the birthdate of the person



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

attribute :birthdate

#city ⇒ String?

Returns the city of the person.

Returns:

  • (String, nil) —

    the city of the person



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

attribute :city

#company ⇒ LWS::Auth::Company

Returns the company the person belongs to.

Returns:



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

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

#company_id ⇒ Integer

Returns the ID of the company the person belongs to.

Returns:

  • (Integer) —

    the ID of the company the person belongs to



483
 
# 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.

Returns:

  • (String) —

    the name of the company the person works for



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

attribute :company_name

#country ⇒ String?

Returns the country of the person.

Returns:

  • (String, nil) —

    the country of the person



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

attribute :country

#customer_reference ⇒ String?

Returns the customer specific reference for the person.

Returns:

  • (String, nil) —

    the customer specific reference for the person



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

attribute :customer_reference

#email ⇒ String?

Returns the email address of the person.

Returns:

  • (String, nil) —

    the email address of the person



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

attribute :email

#ero ⇒ Boolean

Returns whether the person is emergency response ceritified.

Returns:

  • (Boolean) —

    whether the person is emergency response ceritified



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

attribute :ero

#extra_info ⇒ String?

Returns some extra info for the person.

Returns:

  • (String, nil) —

    some extra info for the person



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

attribute :extra_info

#import_ref ⇒ String?

Returns reference of the person in the remote database.

Returns:

  • (String, nil) —

    reference of the person in the remote database



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

attribute :import_ref

#kind ⇒ "employee", "guest"

Returns the person kind.

Returns:

  • ("employee", "guest") —

    the person kind



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

attribute :kind

#last_sync ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :last_sync

#lat ⇒ Float?

Returns the exact latitude of the person’s location.

Returns:

  • (Float, nil) —

    the exact latitude of the person’s location



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

attribute :lat

#location ⇒ Location

Returns the location the person is located at.

Returns:

  • (Location) —

    the location the person is located at



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

belongs_to :location

#location_ancestors_ids ⇒ Array<Integer>

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

Returns:

  • (Array<Integer>) —

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



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

attribute :location_ancestor_ids

#location_id ⇒ Integer

Returns the ID of the location the person is located at.

Returns:

  • (Integer) —

    the ID of the location the person is located at



537
 
# 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">

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

Returns:

  • (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



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

attribute :location_status_change_permissions

#long ⇒ Float?

Returns the exact longitude of the person’s location.

Returns:

  • (Float, nil) —

    the exact longitude of the person’s location



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

attribute :long

#name ⇒ String

Returns the name of the person.

Returns:

  • (String) —

    the name of the person



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

attribute :name

#people_responsible_for ⇒ Array<Person>

Returns the people the person is responsible for.

Returns:

  • (Array<Person>) —

    the people the person is responsible for



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

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

#person_responsible ⇒ Person?

Returns the person responsible for this person.

Returns:

  • (Person, nil) —

    the person responsible for this person



561
562
563
 
# 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?

Returns the ID of the person responsible for this person.

Returns:

  • (Integer, nil) —

    the ID of the person responsible for this person



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

attribute :person_responsible_id

#phone_extension ⇒ String

Returns the fixed phonenumber extension of the person.

Returns:

  • (String) —

    the fixed phonenumber extension of the person



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

attribute :phone_extension

#phone_fixed ⇒ String

Returns the fixed phonenumber of the person.

Returns:

  • (String) —

    the fixed phonenumber of the person



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

attribute :phone_fixed

#phone_mobile ⇒ String

Returns the mobile phonenumber of the person.

Returns:

  • (String) —

    the mobile phonenumber of the person



579
 
# 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.

Returns:

  • (String, nil) —

    the URL of the picture of the person



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

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.

Returns:

  • (Boolean) —

    if a person is present at a location. It looks at the state of a person so that local state checking is not needed.



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

attribute :present

#rfid ⇒ String?

Returns the RFID tag ID linked to the person.

Returns:

  • (String, nil) —

    the RFID tag ID linked to the person



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

attribute :rfid

#status ⇒ "available", ...

Returns the presence status of the person.

Returns:

  • ("available", "busy", "away", "disabled", nil) —

    the presence status of the person



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

attribute :status

#udid ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :udid

#vehicle_registration_plate ⇒ String?

Returns The vehicle registration plate of the persons transport.

Returns:

  • (String, nil) —

    The vehicle registration plate of the persons transport



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

attribute :vehicle_registration_plate

#visibility ⇒ "public", "private"

Returns if a person should be protected by not showing critical information.

Returns:

  • ("public", "private") —

    if a person should be protected by not showing critical information



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

attribute :visibility

#zip_code ⇒ String?

Returns the zip code of the person.

Returns:

  • (String, nil) —

    the zip code of the person



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

attribute :zip_code