Class: ProntoForms::FormIteration

Inherits:
Resource
  • Object
show all
Defined in:
lib/prontoforms/form_iteration.rb

Overview

A form iteration is a form configuration, distinct from a form version in that version numbers increment when a form iteration is deployed.

Instance Attribute Summary

Attributes inherited from Resource

#client, #data, #parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#initialize, property, #resource_name

Constructor Details

This class inherits a constructor from ProntoForms::Resource

Class Method Details

.resource_name ⇒ Object 



9
10
11
 
# File 'lib/prontoforms/form_iteration.rb', line 9

def self.resource_name
  'iterations'
end

Instance Method Details

#dispatched_declinable ⇒ String Also known as: can_decline_dispatch?

Returns Can dispatched forms of this iteration be declined.

Returns:

  • (String) —

    Can dispatched forms of this iteration be declined



22
 
# File 'lib/prontoforms/form_iteration.rb', line 22

property :dispatched_declinable, key: 'dispatchDeclinable'

#document_ids ⇒ Array

Returns Array of document IDs attached to this iteration.

Returns:

  • (Array) —

    Array of document IDs attached to this iteration



27
28
29
 
# File 'lib/prontoforms/form_iteration.rb', line 27

def document_ids
  full_data.fetch('documentIds')
end

#id ⇒ String

Returns The form iteration identifier.

Returns:

  • (String) —

    The form iteration identifier



14
 
# File 'lib/prontoforms/form_iteration.rb', line 14

property :id, key: 'identifier'

#initiation_method ⇒ String

Returns Initiation method for the form iteration.

Returns:

  • (String) —

    Initiation method for the form iteration



20
 
# File 'lib/prontoforms/form_iteration.rb', line 20

property :initiation_method, key: 'initiationMethod'

#state ⇒ String

Returns Form iteration state.

Returns:

  • (String) —

    Form iteration state



18
 
# File 'lib/prontoforms/form_iteration.rb', line 18

property :state, key: 'state'

#version ⇒ Integer

Returns Version number.

Returns:

  • (Integer) —

    Version number



16
 
# File 'lib/prontoforms/form_iteration.rb', line 16

property :version, key: 'version'