module PlaceOS::Driver::Interface::Lockers

Included Modules

Defined in:

placeos-driver/interface/lockers.cr

Instance Method Summary

Instance methods inherited from module PlaceOS::Driver::Interface::Locatable

check_ownership_of(mac_address : String) : OwnershipMAC | Nil check_ownership_of, device_locations(zone_id : String, location : String | Nil = nil) device_locations, locate_user(email : String | Nil = nil, username : String | Nil = nil) locate_user, macs_assigned_to(email : String | Nil = nil, username : String | Nil = nil) : Array(String) macs_assigned_to

Instance Method Detail

abstract def locker_allocate(user_id : String, bank_id : String | Int64, locker_id : String | Int64 | Nil = nil, expires_at : Int64 | Nil = nil) : PlaceLocker #

allocates a locker now, the allocation may expire


[View source]
def locker_allocate_me(bank_id : String | Int64, locker_id : String | Int64 | Nil = nil, expires_at : Int64 | Nil = nil) #

[View source]
abstract def locker_release(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil) : Nil #

return the locker to the pool


[View source]
def locker_release_mine(bank_id : String | Int64, locker_id : String | Int64) #

[View source]
abstract def locker_share(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, share_with : String) : Nil #

[View source]
def locker_share_mine(bank_id : String | Int64, locker_id : String | Int64, share_with : String) #

[View source]
abstract def locker_shared_with(bank_id : String | Int64, locker_id : String | Int64, owner_id : String) : Array(String) #

a list of user-ids that the locker is shared with. this can be placeos user ids or emails


[View source]
def locker_shared_with_others(bank_id : String | Int64, locker_id : String | Int64) #

[View source]
abstract def locker_unlock(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil, open_time : Int32 = 60) : Nil #

[View source]
def locker_unlock_mine(bank_id : String | Int64, locker_id : String | Int64, open_time : Int32 = 60) #

[View source]
abstract def locker_unshare(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, shared_with_id : String | Nil = nil) : Nil #

[View source]
def locker_unshare_mine(bank_id : String | Int64, locker_id : String | Int64, shared_with_id : String | Nil = nil) #

[View source]
abstract def lockers_allocated_to(user_id : String) : Array(PlaceLocker) #

a list of lockers that are allocated to the user


[View source]
def lockers_allocated_to_me #

[View source]