Class: Files::MessageReaction

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MessageReaction.



7
8
9
10
 
# File 'lib/files.com/models/message_reaction.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/message_reaction.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



83
84
85
 
# File 'lib/files.com/models/message_reaction.rb', line 83

def self.all(params = {}, options = {})
  list(params, options)
end

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
emoji (required) - string - Emoji to react with.

Raises:



106
107
108
109
110
111
112
113
 
# File 'lib/files.com/models/message_reaction.rb', line 106

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

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

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

Raises:



115
116
117
118
119
120
121
122
123
 
# File 'lib/files.com/models/message_reaction.rb', line 115

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

  response, _options = Api.send_request("/message_reactions/#{params[:id]}", :delete, params, options)
  response.data
end

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



125
126
127
 
# File 'lib/files.com/models/message_reaction.rb', line 125

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

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

Parameters:

id (required) - int64 - Message Reaction ID.

Raises:



89
90
91
92
93
94
95
96
97
 
# File 'lib/files.com/models/message_reaction.rb', line 89

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

  response, options = Api.send_request("/message_reactions/#{params[:id]}", :get, params, options)
  MessageReaction.new(response.data, options)
end

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



99
100
101
 
# File 'lib/files.com/models/message_reaction.rb', line 99

def self.get(id, params = {}, options = {})
  find(id, params, options)
end

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
page - int64 - Current page number.
per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
message_id (required) - int64 - Message to return reactions for.

Raises:



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/files.com/models/message_reaction.rb', line 69

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

  List.new(MessageReaction, params) do
    Api.send_request("/message_reactions", :get, params, options)
  end
end

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



39
40
41
42
43
44
45
46
47
 
# File 'lib/files.com/models/message_reaction.rb', line 39

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.dig(:id) and !params.dig(:id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)

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

#destroy(params = {}) ⇒ Object 



49
50
51
 
# File 'lib/files.com/models/message_reaction.rb', line 49

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

#emoji ⇒ Object

string - Emoji used in the reaction.



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

def emoji
  @attributes[:emoji]
end

#emoji=(value) ⇒ Object 



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

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

#id ⇒ Object

int64 - Reaction ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#save ⇒ Object 



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

def save
  if @attributes[:id]
    raise NotImplementedError.new("The MessageReaction object doesn't support updates.")
  else
    new_obj = MessageReaction.create(@attributes, @options)
    @attributes = new_obj.attributes
  end
end

#user_id ⇒ Object

int64 - User ID. Provide a value of ‘0` to operate the current session’s user.



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

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



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

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