Class: RedSnow::Sourcemap::Action

Inherits:
NamedNode show all
Defined in:
lib/redsnow/sourcemap.rb

Overview

Action source map node

Instance Attribute Summary collapse

Attributes inherited from NamedNode

#description, #name

Instance Method Summary collapse

Constructor Details

#initialize(sc_sm_action_handle) ⇒ Action

Returns a new instance of Action.

Parameters:

  • sc_sm_action_handle (FFI::Pointer) 


243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/redsnow/sourcemap.rb', line 243

def initialize(sc_sm_action_handle)
  @name = SourceMap.new(RedSnow::Binding.sc_sm_action_name(sc_sm_action_handle))
  @description = SourceMap.new(RedSnow::Binding.sc_sm_action_description(sc_sm_action_handle))

  @method = SourceMap.new(RedSnow::Binding.sc_sm_action_httpmethod(sc_sm_action_handle))

  @parameters = Parameters.new(RedSnow::Binding.sc_sm_parameter_collection_handle_action(sc_sm_action_handle))

  @examples = Array.new
  sc_sm_transaction_example_collection_handle = RedSnow::Binding.sc_sm_transaction_example_collection_handle(sc_sm_action_handle)
  sc_sm_transaction_example_collection_size = RedSnow::Binding.sc_sm_transaction_example_collection_size(sc_sm_transaction_example_collection_handle)

  if sc_sm_transaction_example_collection_size > 0
    examples_size = sc_sm_transaction_example_collection_size - 1

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

Instance Attribute Details

#examples ⇒ Array<TransactionExample>

action transaction examples

Returns:



236
237
238
 
# File 'lib/redsnow/sourcemap.rb', line 236

def examples
  @examples
end

#method ⇒ Sourcemap

HTTP request method or nil

Returns:

  • (Sourcemap) —

    the current value of method



236
237
238
 
# File 'lib/redsnow/sourcemap.rb', line 236

def method
  @method
end

#parameters ⇒ Parameters

action-specific URI parameters or nil

Returns:

  • (Parameters) —

    the current value of parameters



236
237
238
 
# File 'lib/redsnow/sourcemap.rb', line 236

def parameters
  @parameters
end