Class: Comet::AdminU2FRegistration Deprecated

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

Overview

Deprecated.

This type has been deprecated since Comet version 21.12.0

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAdminU2FRegistration

Returns a new instance of AdminU2FRegistration.



31
32
33
# File 'lib/comet/models/admin_u2fregistration.rb', line 31

def initialize
  clear
end

Instance Attribute Details

#descriptionObject

Returns the value of attribute description.



18
19
20
# File 'lib/comet/models/admin_u2fregistration.rb', line 18

def description
  @description
end

#register_timeObject

Unix timestamp, in seconds.



22
23
24
# File 'lib/comet/models/admin_u2fregistration.rb', line 22

def register_time
  @register_time
end

#registrationObject

When this field is expressed as a AdminU2FRegistration 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.



26
27
28
# File 'lib/comet/models/admin_u2fregistration.rb', line 26

def registration
  @registration
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



29
30
31
# File 'lib/comet/models/admin_u2fregistration.rb', line 29

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clearObject



35
36
37
38
39
40
# File 'lib/comet/models/admin_u2fregistration.rb', line 35

def clear
  @description = ''
  @register_time = 0
  @registration = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/comet/models/admin_u2fregistration.rb', line 50

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 'Description'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @description = v
    when 'RegisterTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @register_time = v
    when 'Registration'
      @registration = 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)


43
44
45
46
47
# File 'lib/comet/models/admin_u2fregistration.rb', line 43

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



84
85
86
# File 'lib/comet/models/admin_u2fregistration.rb', line 84

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



72
73
74
75
76
77
78
79
80
81
# File 'lib/comet/models/admin_u2fregistration.rb', line 72

def to_hash
  ret = {}
  ret['Description'] = @description
  ret['RegisterTime'] = @register_time
  ret['Registration'] = Base64.strict_encode64(@registration)
  @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



89
90
91
# File 'lib/comet/models/admin_u2fregistration.rb', line 89

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