Class: Files::FileComment

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/file_comment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ FileComment

Returns a new instance of FileComment.



7
8
9
10
 
# File 'lib/files.com/models/file_comment.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/file_comment.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/file_comment.rb', line 5

def options
  @options
end

Class Method Details

.create(params = {}, options = {}) ⇒ Object

Parameters:

body (required) - string - Comment body.
path (required) - string - File path.

Raises:



112
113
114
115
116
117
118
119
120
 
# File 'lib/files.com/models/file_comment.rb', line 112

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
  raise MissingParameterError.new("Parameter missing: body") unless params[:body]
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]

  response, options = Api.send_request("/file_comments", :post, params, options)
  FileComment.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



136
137
138
139
140
141
142
143
144
 
# File 'lib/files.com/models/file_comment.rb', line 136

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/file_comments/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



146
147
148
149
 
# File 'lib/files.com/models/file_comment.rb', line 146

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.list_for(path, params = {}, options = {}) ⇒ Object

Parameters:

cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string
page - int64
path (required) - string - Path to operate on.

Raises:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/files.com/models/file_comment.rb', line 94

def self.list_for(path, params = {}, options = {})
  params ||= {}
  params[:path] = path
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params[:path]

  List.new(FileComment, params) do
    Api.send_request("/file_comments/files/#{params[:path]}", :get, params, options)
  end
end

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

body (required) - string - Comment body.

Raises:



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/files.com/models/file_comment.rb', line 124

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
  raise MissingParameterError.new("Parameter missing: body") unless params[:body]

  response, options = Api.send_request("/file_comments/#{params[:id]}", :patch, params, options)
  FileComment.new(response.data, options)
end

Instance Method Details

#body ⇒ Object

string - Comment body.



22
23
24
 
# File 'lib/files.com/models/file_comment.rb', line 22

def body
  @attributes[:body]
end

#body=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/file_comment.rb', line 26

def body=(value)
  @attributes[:body] = value
end

#delete(params = {}) ⇒ Object

Raises:



62
63
64
65
66
67
68
69
70
 
# File 'lib/files.com/models/file_comment.rb', line 62

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/file_comments/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



72
73
74
75
 
# File 'lib/files.com/models/file_comment.rb', line 72

def destroy(params = {})
  delete(params)
  nil
end

#id ⇒ Object

int64 - File Comment ID



13
14
15
 
# File 'lib/files.com/models/file_comment.rb', line 13

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/file_comment.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#path ⇒ Object

string - File path.



40
41
42
 
# File 'lib/files.com/models/file_comment.rb', line 40

def path
  @attributes[:path]
end

#path=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/file_comment.rb', line 44

def path=(value)
  @attributes[:path] = value
end

#reactions ⇒ Object

array(object) - Reactions to this comment.



31
32
33
 
# File 'lib/files.com/models/file_comment.rb', line 31

def reactions
  @attributes[:reactions]
end

#reactions=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/file_comment.rb', line 35

def reactions=(value)
  @attributes[:reactions] = value
end

#save ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/files.com/models/file_comment.rb', line 77

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = FileComment.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

Parameters:

body (required) - string - Comment body.

Raises:



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/files.com/models/file_comment.rb', line 50

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: body must be an String") if params[:body] and !params[:body].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
  raise MissingParameterError.new("Parameter missing: body") unless params[:body]

  Api.send_request("/file_comments/#{@attributes[:id]}", :patch, params, @options)
end