module

PlaceOS::Driver::Interface::Lockers

Inherits PlaceOS::Driver::Interface::Locatable

Instance methods

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

Source
locker_allocate_me(bank_id : String | Int64, locker_id : String | Int64 | Nil = nil, expires_at : Int64 | Nil = nil)
Source
locker_release(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil) : Nil

return the locker to the pool

Source
locker_release_mine(bank_id : String | Int64, locker_id : String | Int64)
Source
locker_share(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, share_with : String) : Nil
Source
locker_share_mine(bank_id : String | Int64, locker_id : String | Int64, share_with : String)
Source
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

Source
locker_shared_with_others(bank_id : String | Int64, locker_id : String | Int64)
Source
locker_unlock(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil, open_time : Int32 = 60) : Nil
Source
locker_unlock_mine(bank_id : String | Int64, locker_id : String | Int64, open_time : Int32 = 60)
Source
locker_unshare(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, shared_with_id : String | Nil = nil) : Nil
Source
locker_unshare_mine(bank_id : String | Int64, locker_id : String | Int64, shared_with_id : String | Nil = nil)
Source
lockers_allocated_to(user_id : String) : Array(PlaceLocker)

a list of lockers that are allocated to the user

Source
lockers_allocated_to_me
Source

Nested types