Class: RubyAem::Result
- Inherits:
-
Object
- Object
- RubyAem::Result
- Defined in:
- lib/ruby_aem/result.rb
Overview
Result class represents the result of a client call. It contains the following attributes:
-
message: a message string containing the description of the result
-
response: a RubyAem::Response response from AEM
-
data: the data payload, which can be of any type depending on the API call
e.g. is_* and exists method provide result with boolean data. Some API calls result doesn’t contain any data.
Instance Attribute Summary collapse
-
#data ⇒ Object
Returns the value of attribute data.
-
#message ⇒ Object
Returns the value of attribute message.
-
#response ⇒ Object
readonly
Returns the value of attribute response.
Instance Method Summary collapse
-
#initialize(message, response) ⇒ Object
constructor
Initialise a result.
Constructor Details
#initialize(message, response) ⇒ Object
Initialise a result.
33 34 35 36 |
# File 'lib/ruby_aem/result.rb', line 33 def initialize(, response) @message = @response = response end |
Instance Attribute Details
#data ⇒ Object
Returns the value of attribute data.
26 27 28 |
# File 'lib/ruby_aem/result.rb', line 26 def data @data end |
#message ⇒ Object
Returns the value of attribute message.
24 25 26 |
# File 'lib/ruby_aem/result.rb', line 24 def @message end |
#response ⇒ Object (readonly)
Returns the value of attribute response.
25 26 27 |
# File 'lib/ruby_aem/result.rb', line 25 def response @response end |