Class: RedSnow::Action

Inherits:
NamedBlueprintNode show all
Defined in:
lib/redsnow/blueprint.rb

Overview

Action Blueprint AST node

represetns 'action sction'

Instance Attribute Summary collapse

Attributes inherited from NamedBlueprintNode

#description, #name

Instance Method Summary collapse

Methods inherited from NamedBlueprintNode

#ensure_description_newlines

Constructor Details

#initialize(sc_action_handle) ⇒ Action

Returns a new instance of Action.

Parameters:

  • sc_action_handle (FFI::Pointer) 


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/redsnow/blueprint.rb', line 300

def initialize(sc_action_handle)
  @name = RedSnow::Binding.sc_action_name(sc_action_handle)
  @description = RedSnow::Binding.sc_action_description(sc_action_handle)

  @method = RedSnow::Binding.sc_action_httpmethod(sc_action_handle)

  @parameters = Parameters.new(RedSnow::Binding.sc_parameter_collection_handle_action(sc_action_handle))

  @examples = Array.new
  sc_transaction_example_collection_handle = RedSnow::Binding.sc_transaction_example_collection_handle(sc_action_handle)
  sc_transaction_example_collection_size = RedSnow::Binding.sc_transaction_example_collection_size(sc_transaction_example_collection_handle)

  if sc_transaction_example_collection_size > 0
    examples_size = sc_transaction_example_collection_size - 1

    for index in 0..examples_size do
      sc_transaction_example_handle = RedSnow::Binding.sc_transaction_example_handle(sc_transaction_example_collection_handle, index)
      @examples << TransactionExample.new(sc_transaction_example_handle)
    end
  end
end

Instance Attribute Details

#examples ⇒ Array<TransactionExample>

action transaction examples

Returns:



293
294
295
 
# File 'lib/redsnow/blueprint.rb', line 293

def examples
  @examples
end

#method ⇒ String

HTTP request method or nil

Returns:

  • (String) —

    the current value of method



293
294
295
 
# File 'lib/redsnow/blueprint.rb', line 293

def method
  @method
end

#parameters ⇒ Parameters

action-specific URI parameters or nil

Returns:

  • (Parameters) —

    the current value of parameters



293
294
295
 
# File 'lib/redsnow/blueprint.rb', line 293

def parameters
  @parameters
end