Class: Comet::WebDavDestinationLocation

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

Overview

WebDavDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure. This type is available in Comet 23.6.9 and later.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebDavDestinationLocation

Returns a new instance of WebDavDestinationLocation.



35
36
37
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 35

def initialize
  clear
end

Instance Attribute Details

#access_key ⇒ Object

The password for logging in to the WebDAV server



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

def access_key
  @access_key
end

#dav_server ⇒ Object

The URL of the WebDAV server, including http/https and any custom port



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

def dav_server
  @dav_server
end

#path ⇒ Object

The target directory path within the WebDAV server



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

def path
  @path
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



33
34
35
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 33

def unknown_json_fields
  @unknown_json_fields
end

#user_name ⇒ Object

The username for logging in to the WebDAV server



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

def user_name
  @user_name
end

Instance Method Details

#clear ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 39

def clear
  @dav_server = ''
  @user_name = ''
  @access_key = ''
  @path = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 55

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

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

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

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

      @path = 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) 


48
49
50
51
52
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 48

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



104
105
106
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 104

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 83

def to_hash
  ret = {}
  unless @dav_server.nil?
    ret['DavServer'] = @dav_server
  end
  unless @user_name.nil?
    ret['UserName'] = @user_name
  end
  unless @access_key.nil?
    ret['AccessKey'] = @access_key
  end
  unless @path.nil?
    ret['Path'] = @path
  end
  @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



109
110
111
 
# File 'lib/comet/models/web_dav_destination_location.rb', line 109

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