Class: Verizon::Location

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/location.rb

Overview

Device location information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(msid = SKIP, pd = SKIP, error = SKIP) ⇒ Location

Returns a new instance of Location.



47
48
49
50
51
 
# File 'lib/verizon/models/location.rb', line 47

def initialize(msid = SKIP, pd = SKIP, error = SKIP)
  @msid = msid unless msid == SKIP
  @pd = pd unless pd == SKIP
  @error = error unless error == SKIP
end

Instance Attribute Details

#error ⇒ PositionError

Position error.

Returns:



22
23
24
 
# File 'lib/verizon/models/location.rb', line 22

def error
  @error
end

#msid ⇒ String

MDN.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/location.rb', line 14

def msid
  @msid
end

#pd ⇒ PositionData

Position data.

Returns:



18
19
20
 
# File 'lib/verizon/models/location.rb', line 18

def pd
  @pd
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/verizon/models/location.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  msid = hash.key?('msid') ? hash['msid'] : SKIP
  pd = PositionData.from_hash(hash['pd']) if hash['pd']
  error = PositionError.from_hash(hash['error']) if hash['error']

  # Create object from extracted values.
  Location.new(msid,
               pd,
               error)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/verizon/models/location.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['msid'] = 'msid'
  @_hash['pd'] = 'pd'
  @_hash['error'] = 'error'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/verizon/models/location.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/verizon/models/location.rb', line 34

def self.optionals
  %w[
    msid
    pd
    error
  ]
end