class GroupDocs::Signature::List
Attributes
defaultValue[RW]
@attr [String] defaultValue
id[RW]
@attr [String] id
name[RW]
@attr [String] name
values[RW]
@attr [Array<String>] values
Public Class Methods
get!(access = {})
click to toggle source
Returns array of predefined lists.
@param [Hash] access Access credentials @option access [String] :client_id @option access [String] :private_key @return [Array<GroupDocs::Signature::List>]
# 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
Public Instance Methods
add!(access = {})
click to toggle source
Adds predefined list.
@example
list = GroupDocs::Signature::List.new list.name = 'Cities' list.values = %w(London Paris) list.add!
@param [Hash] access Access credentials @option access [String] :client_id @option access [String] :private_key
# 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 = {})
click to toggle source
Deletes predefined list.
@param [Hash] access Access credentials @option access [String] :client_id @option access [String] :private_key
# 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
values=(values)
click to toggle source
Converts values to API compatible view. @param [Array<String>, String] values
# File lib/groupdocs/signature/list.rb, line 40 def values=(values) @values = values.is_a?(Array) ? values.join(';') : values end