Class: ApiAlerts::SendResult

Inherits:
Object
  • Object
show all
Defined in:
lib/apialerts/result.rb

Overview

The result of an event delivery attempt.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success:, workspace: nil, channel: nil, warnings: [], error: nil) ⇒ SendResult

Returns a new instance of SendResult.



6
7
8
9
10
11
12
 
# File 'lib/apialerts/result.rb', line 6

def initialize(success:, workspace: nil, channel: nil, warnings: [], error: nil)
  @success   = success
  @workspace = workspace
  @channel   = channel
  @warnings  = warnings
  @error     = error
end

Instance Attribute Details

#channel ⇒ Object (readonly)

Returns the value of attribute channel.



4
5
6
 
# File 'lib/apialerts/result.rb', line 4

def channel
  @channel
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



4
5
6
 
# File 'lib/apialerts/result.rb', line 4

def error
  @error
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



4
5
6
 
# File 'lib/apialerts/result.rb', line 4

def success
  @success
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



4
5
6
 
# File 'lib/apialerts/result.rb', line 4

def warnings
  @warnings
end

#workspace ⇒ Object (readonly)

Returns the value of attribute workspace.



4
5
6
 
# File 'lib/apialerts/result.rb', line 4

def workspace
  @workspace
end

Instance Method Details

#success? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/apialerts/result.rb', line 14

def success?
  @success
end