Class: GroupDocs::Signature::List

Inherits:
Api::Entity show all
Defined in:
lib/groupdocs/signature/list.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Methods included from Api::Helpers::Accessor

#alias_accessor

Constructor Details

This class inherits a constructor from GroupDocs::Api::Entity

Instance Attribute Details

#defaultValue ⇒ Object 



31
32
33
 
# File 'lib/groupdocs/signature/list.rb', line 31

def defaultValue
  @defaultValue
end

#id ⇒ Object 



25
26
27
 
# File 'lib/groupdocs/signature/list.rb', line 25

def id
  @id
end

#name ⇒ Object 



27
28
29
 
# File 'lib/groupdocs/signature/list.rb', line 27

def name
  @name
end

#values ⇒ Array<String>

Returns values as array.

Returns:

  • (Array<String>) 


29
30
31
 
# File 'lib/groupdocs/signature/list.rb', line 29

def values
  @values
end

Class Method Details

.get!(access = {}) ⇒ Array<GroupDocs::Signature::List>

Returns array of predefined lists.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/groupdocs/signature/list.rb', line 12

def self.get!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/signature/{{client_id}}/lists'
  end.execute!

  json[:lists].map do |list|
    new(list)
  end
end

Instance Method Details

#add!(access = {}) ⇒ Object

Adds predefined list.

Examples:

list = GroupDocs::Signature::List.new
list.name = 'Cities'
list.values = %w(London Paris)
list.add!

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


65
66
67
68
69
70
71
72
73
74
 
# File 'lib/groupdocs/signature/list.rb', line 65

def add!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :POST
    request[:path] = '/signature/{{client_id}}/list'
    request[:request_body] = to_hash
  end.execute!

  self.id = json[:list][:id]
end

#delete!(access = {}) ⇒ Object

Deletes predefined list.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


83
84
85
86
87
88
89
 
# File 'lib/groupdocs/signature/list.rb', line 83

def delete!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :DELETE
    request[:path] = "/signature/{{client_id}}/lists/#{id}"
  end.execute!
end