Class: Seam::Resources::SeamEvent::LockLocked

Inherits:
SeamEvent
  • Object
show all
Defined in:
lib/seam/resources/event.rb

Overview

A lock was locked.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#access_code_id ⇒ String?

ID of the access code that was used to lock the device.

Returns:

  • (String, nil) 


4271
4272
4273
 
# File 'lib/seam/resources/event.rb', line 4271

def access_code_id
  @access_code_id
end

#access_code_is_managed ⇒ Boolean?

Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set.

Returns:

  • (Boolean, nil) 


4274
4275
4276
 
# File 'lib/seam/resources/event.rb', line 4274

def access_code_is_managed
  @access_code_is_managed
end

#action_attempt_id ⇒ String?

ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a LOCK_DOOR action attempt).

Returns:

  • (String, nil) 


4277
4278
4279
 
# File 'lib/seam/resources/event.rb', line 4277

def action_attempt_id
  @action_attempt_id
end

#code ⇒ String?

Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.

Returns:

  • (String, nil) 


4280
4281
4282
 
# File 'lib/seam/resources/event.rb', line 4280

def code
  @code
end

#connected_account_custom_metadata ⇒ Hash{String => String, Boolean}?

Custom metadata of the connected account, present when connected_account_id is provided.

Returns:

  • (Hash{String => String, Boolean}, nil) 


4283
4284
4285
 
# File 'lib/seam/resources/event.rb', line 4283

def 
  @connected_account_custom_metadata
end

#connected_account_id ⇒ String

ID of the connected account associated with the event.

Returns:

  • (String) 


4286
4287
4288
 
# File 'lib/seam/resources/event.rb', line 4286

def 
  @connected_account_id
end

#customer_key ⇒ String?

The customer key associated with the device, if any.

Returns:

  • (String, nil) 


4289
4290
4291
 
# File 'lib/seam/resources/event.rb', line 4289

def customer_key
  @customer_key
end

#device_custom_metadata ⇒ Hash{String => String, Boolean}?

Custom metadata of the device, present when device_id is provided.

Returns:

  • (Hash{String => String, Boolean}, nil) 


4292
4293
4294
 
# File 'lib/seam/resources/event.rb', line 4292

def device_custom_metadata
  @device_custom_metadata
end

#device_id ⇒ String

ID of the affected device.

Returns:

  • (String) 


4295
4296
4297
 
# File 'lib/seam/resources/event.rb', line 4295

def device_id
  @device_id
end

#event_description ⇒ String?

Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.

Returns:

  • (String, nil) 


4298
4299
4300
 
# File 'lib/seam/resources/event.rb', line 4298

def event_description
  @event_description
end

#event_id ⇒ String

ID of the event.

Returns:

  • (String) 


4301
4302
4303
 
# File 'lib/seam/resources/event.rb', line 4301

def event_id
  @event_id
end

#event_type ⇒ String

Known values:

  • lock.locked

Returns:

  • (String) 


4305
4306
4307
 
# File 'lib/seam/resources/event.rb', line 4305

def event_type
  @event_type
end

#is_via_bluetooth ⇒ Boolean?

Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.

Returns:

  • (Boolean, nil) 


4308
4309
4310
 
# File 'lib/seam/resources/event.rb', line 4308

def is_via_bluetooth
  @is_via_bluetooth
end

#is_via_nfc ⇒ Boolean?

Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.

Returns:

  • (Boolean, nil) 


4311
4312
4313
 
# File 'lib/seam/resources/event.rb', line 4311

def is_via_nfc
  @is_via_nfc
end

#workspace_id ⇒ String

ID of the workspace associated with the event.

Returns:

  • (String) 


4324
4325
4326
 
# File 'lib/seam/resources/event.rb', line 4324

def workspace_id
  @workspace_id
end

Instance Method Details

#created_at ⇒ Time

Date and time at which the event was created.

Returns:

  • (Time) 


4327
 
# File 'lib/seam/resources/event.rb', line 4327

date_accessor :created_at

#event_method ⇒ String

Method by which the lock was locked. keycode: an access code was used (see access_code_id). manual: a physical action such as a thumbturn or button press. remote: a remote action via an app, Bluetooth, or the Seam API (see action_attempt_id if Seam-initiated; see is_via_bluetooth or is_via_nfc for the transport). automatic: triggered automatically, for example by an auto-relock timer. unknown: could not be determined. Known values:

  • keycode
  • manual
  • automatic
  • unknown
  • remote
  • card

Returns:

  • (String) 


4321
 
# File 'lib/seam/resources/event.rb', line 4321

aliased_accessor :event_method, from: :method

#occurred_at ⇒ Time

Date and time at which the event occurred.

Returns:

  • (Time) 


4330
 
# File 'lib/seam/resources/event.rb', line 4330

date_accessor :occurred_at