Class: Comet::WebAuthnUserEntity

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/web_authn_user_entity.rb

Overview

WebAuthnUserEntity is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebAuthnUserEntity

Returns a new instance of WebAuthnUserEntity.



32
33
34
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 32

def initialize
  clear
end

Instance Attribute Details

#display_name ⇒ Object

Returns the value of attribute display_name.



23
24
25
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 23

def display_name
  @display_name
end

#icon ⇒ Object

Returns the value of attribute icon.



20
21
22
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 20

def icon
  @icon
end

#id ⇒ Object

When this field is expressed as a WebAuthnUserEntity class instance, this field may contain binary data. When this field is expressed as JSON, the field is expressed as base64. The marshalling methods on this class will automatically perform base64 conversion as necessary.



27
28
29
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 27

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



17
18
19
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 17

def name
  @name
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



30
31
32
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 30

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 36

def clear
  @name = ''
  @icon = ''
  @display_name = ''
  @id = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 52

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'name'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @name = v
    when 'icon'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @icon = v
    when 'displayName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @display_name = v
    when 'id'
      @id = Base64.decode64(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


45
46
47
48
49
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 45

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



95
96
97
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 95

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 78

def to_hash
  ret = {}
  ret['name'] = @name
  unless @icon.nil?
    ret['icon'] = @icon
  end
  unless @display_name.nil?
    ret['displayName'] = @display_name
  end
  ret['id'] = Base64.strict_encode64(@id)
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



100
101
102
 
# File 'lib/comet/models/web_authn_user_entity.rb', line 100

def to_json(options = {})
  to_hash.to_json(options)
end