Class: Echochamber::WidgetSecurityOption

Inherits:
Hash
  • Object
show all
Includes:
Validatable
Defined in:
lib/echochamber/widget/widget_security_option.rb

Instance Method Summary collapse

Methods included from Validatable

#require_exactly_one, #require_keys, #validate_field

Constructor Details

#initialize(params) ⇒ WidgetSecurityOption

Widget initialization object

Parameters:

  • params (Hash)

    SYMBOL-referenced Hash containing:

Options Hash (params):

  • :passwordProtection (String)

    Specifies if signers are required to enter a password to have access to sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS

  • :kbaProtection (String)

    Signers need to pass Knowledge Based Authentication before they gain access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS

  • :webIdentityProtection (String)

    Specifies if signers are required to provide their web identity, before they gain access to view and sign the widget. The possible values are NONE, EXTERNAL_USERS, INTERNAL_USERS, or ALL_USERS

  • :protectOpen (Boolean)

    If set to true, the document is always be encrypted with this password every time it is sent by email. Recipients need to provide the password to be able to view the PDF files

  • :internalPassword (String)

    The secondary password that will be used to protect signing the widget for internal signers. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for internal signers or all signers

  • :externalPassword (String)

    The secondary password that will be used to protect signing the widget for external signers. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is applied only if password protection is specified for external signers or all signers

  • :openPassword (String)

    The secondary password that will be used to secure the PDF document. Note that EchoSign will never show this password to anyone, so you will need to separately communicate it to any relevant parties. This password is used only if protectOpen field is set to true


16
17
18
# File 'lib/echochamber/widget/widget_security_option.rb', line 16

def initialize(params)
  merge!(params)
end