module PlaceOS::Driver::Interface::ZoneAccessSecurity
Defined in:
placeos-driver/interface/zone_access_security.crInstance Method Summary
-
#card_holder_id_lookup(email : String) : String | Int64 | Nil
using an email address, lookup the security system id for a user
-
#card_holder_lookup(id : String | Int64) : CardHolderDetails
given a card holder id, lookup the details of the card holder
-
#zone_access_add_member(zone_id : String | Int64, card_holder_id : String | Int64, from_unix : Int64 | Nil = nil, until_unix : Int64 | Nil = nil)
add a member to the zone
-
#zone_access_id_lookup(name : String, exact_match : Bool = true) : String | Int64 | Nil
using a name, lookup the access zone id
-
#zone_access_lookup(id : String | Int64) : ZoneDetails
given an access zone id, lookup the details of the zone
-
#zone_access_member?(zone_id : String | Int64, card_holder_id : String | Int64) : String | Int64 | Nil
return the id that represents the access permission (truthy indicates access)
-
#zone_access_remove_member(zone_id : String | Int64, card_holder_id : String | Int64)
remove a member from the zone
Instance Method Detail
abstract
def card_holder_id_lookup(email : String) : String | Int64 | Nil
#
using an email address, lookup the security system id for a user
abstract
def card_holder_lookup(id : String | Int64) : CardHolderDetails
#
given a card holder id, lookup the details of the card holder
abstract
def zone_access_add_member(zone_id : String | Int64, card_holder_id : String | Int64, from_unix : Int64 | Nil = nil, until_unix : Int64 | Nil = nil)
#
add a member to the zone
abstract
def zone_access_id_lookup(name : String, exact_match : Bool = true) : String | Int64 | Nil
#
using a name, lookup the access zone id
abstract
def zone_access_lookup(id : String | Int64) : ZoneDetails
#
given an access zone id, lookup the details of the zone
abstract
def zone_access_member?(zone_id : String | Int64, card_holder_id : String | Int64) : String | Int64 | Nil
#
return the id that represents the access permission (truthy indicates access)
abstract
def zone_access_remove_member(zone_id : String | Int64, card_holder_id : String | Int64)
#
remove a member from the zone