Class: GroupDocs::Document::Annotation::Reviewer

Inherits:
Api::Entity
  • Object
show all
Defined in:
lib/groupdocs/document/annotation/reviewer.rb

Instance Attribute Summary collapse

Class 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

#emailAddress ⇒ Object 



49
50
51
 
# File 'lib/groupdocs/document/annotation/reviewer.rb', line 49

def emailAddress
  @emailAddress
end

#firstName ⇒ Object

Added in release 2.1.0



55
56
57
 
# File 'lib/groupdocs/document/annotation/reviewer.rb', line 55

def firstName
  @firstName
end

#lastName ⇒ Object 



57
58
59
 
# File 'lib/groupdocs/document/annotation/reviewer.rb', line 57

def lastName
  @lastName
end

Class Method Details

.all!(access = {}) ⇒ Array<GroupDocs::Document::Annotation::Reviewer>

Returns all reviewer contacts.

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/document/annotation/reviewer.rb', line 12

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

  json[:reviewerContacts].map do |reviewer|
    new(reviewer)
  end
end

.set!(reviewers, access = {}) ⇒ Object

Sets reviewer contacts to passed array.

Please, note that it removes existing reviewer contacts.

Examples:

Add new reviewer contact

reviewers = GroupDocs::Document::Annotation::Reviewer.all!
reviewers << GroupDocs::Document::Annotation::Reviewer.new(full_name: 'John Smith', email_address: '[email protected]')
GroupDocs::Document::Annotation::Reviewer.set! reviewers

Parameters:

Options Hash (access):

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


39
40
41
42
43
44
45
46
 
# File 'lib/groupdocs/document/annotation/reviewer.rb', line 39

def self.set!(reviewers, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = '/ant/{{client_id}}/reviewerContacts'
    request[:request_body] = reviewers.each.map(&:to_hash)
  end.execute!
end