Class: GroupDocs::Signature

Inherits:
Api::Entity show all
Defined in:
lib/groupdocs/signature.rb,
lib/groupdocs/signature/shared/entity_fields.rb,
lib/groupdocs/signature/shared/field_methods.rb,
lib/groupdocs/signature/shared/entity_methods.rb,
lib/groupdocs/signature/shared/document_methods.rb,
lib/groupdocs/signature/shared/resource_methods.rb,
lib/groupdocs/signature/shared/recipient_methods.rb

Defined Under Namespace

Modules: DocumentMethods, EntityFields, EntityMethods, FieldMethods, RecipientMethods, ResourceMethods Classes: Contact, Envelope, Field, Form, List, Recipient, Role, Template

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Constructor Details

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

Instance Attribute Details

#companyName ⇒ Object Also known as: company_name 



43
44
45
 
# File 'lib/groupdocs/signature.rb', line 43

def companyName
  @companyName
end

#createdTimeStamp ⇒ Object Also known as: created_time_stamp 



63
64
65
 
# File 'lib/groupdocs/signature.rb', line 63

def createdTimeStamp
  @createdTimeStamp
end

#firstName ⇒ Object Also known as: first_name 



47
48
49
 
# File 'lib/groupdocs/signature.rb', line 47

def firstName
  @firstName
end

#fullName ⇒ Object Also known as: full_name 



51
52
53
 
# File 'lib/groupdocs/signature.rb', line 51

def fullName
  @fullName
end

#id ⇒ Object 



35
36
37
 
# File 'lib/groupdocs/signature.rb', line 35

def id
  @id
end

#initialsImageFileId ⇒ Object Also known as: initials_image_file_id 



57
58
59
 
# File 'lib/groupdocs/signature.rb', line 57

def initialsImageFileId
  @initialsImageFileId
end

#initialsImageUrl ⇒ Object Also known as: initials_image_url 



61
62
63
 
# File 'lib/groupdocs/signature.rb', line 61

def initialsImageUrl
  @initialsImageUrl
end

#lastName ⇒ Object Also known as: last_name 



49
50
51
 
# File 'lib/groupdocs/signature.rb', line 49

def lastName
  @lastName
end

#name ⇒ Object 



41
42
43
 
# File 'lib/groupdocs/signature.rb', line 41

def name
  @name
end

#position ⇒ Object 



45
46
47
 
# File 'lib/groupdocs/signature.rb', line 45

def position
  @position
end

#recipientId ⇒ Object Also known as: recipient_id 



39
40
41
 
# File 'lib/groupdocs/signature.rb', line 39

def recipientId
  @recipientId
end

#signatureImageFileId ⇒ Object Also known as: signature_image_file_id 



55
56
57
 
# File 'lib/groupdocs/signature.rb', line 55

def signatureImageFileId
  @signatureImageFileId
end

#signatureImageUrl ⇒ Object Also known as: signature_image_url 



59
60
61
 
# File 'lib/groupdocs/signature.rb', line 59

def signatureImageUrl
  @signatureImageUrl
end

#textInitials ⇒ Object Also known as: text_initials 



53
54
55
 
# File 'lib/groupdocs/signature.rb', line 53

def textInitials
  @textInitials
end

#userGuid ⇒ Object Also known as: user_guid 



37
38
39
 
# File 'lib/groupdocs/signature.rb', line 37

def userGuid
  @userGuid
end

Class Method Details

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

Returns a list of all user signatures.

Parameters:

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

    Access credentials

Options Hash (access):

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

Returns:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/groupdocs/signature.rb', line 22

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

  json[:signatures].map do |signature|
    new(signature)
  end
end

Instance Method Details

#create!(title, access = {}) ⇒ Object

Creates signature.

Examples:

signature = GroupDocs::Signature.new
signature.first_name = 'John'
signature.last_name = 'Smith'
signature.create! "John Smith's Signature"

Parameters:

  • title (String) —

    Signature title

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

    Access credentials

Options Hash (access):

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


105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/groupdocs/signature.rb', line 105

def create!(title, access = {})
  api = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :POST
    request[:path] = '/signature/{{client_id}}/signature'
    request[:request_body] = to_hash
  end
  api.add_params(name: title)
  json = api.execute!

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

#delete!(access = {}) ⇒ Object

Deletes signature.

Parameters:

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

    Access credentials

Options Hash (access):

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


125
126
127
128
129
130
131
 
# File 'lib/groupdocs/signature.rb', line 125

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