Contents

module GroupDocs
  class Document::Annotation::Reviewer < Api::Entity

    #
    # Returns all reviewer contacts.
    #
    # @param [Hash] access Access credentials
    # @option access [String] :client_id
    # @option access [String] :private_key
    # @return [Array<GroupDocs::Document::Annotation::Reviewer>]
    #
    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

    #
    # Sets reviewer contacts to passed array.
    #
    # Please, note that it removes existing reviewer contacts.
    #
    # @example Add new reviewer contact
    #   reviewers = GroupDocs::Document::Annotation::Reviewer.all!
    #   reviewers << GroupDocs::Document::Annotation::Reviewer.new(full_name: 'John Smith', email_address: '[e-mail]')
    #   GroupDocs::Document::Annotation::Reviewer.set! reviewers
    #
    # @param [Array<GroupDocs::Document::Annotation::Reviewer>] reviewers
    # @param [Hash] access Access credentials
    # @option access [String] :client_id
    # @option access [String] :private_key
    #
    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

    # @attr [String] emailAddress
    attr_accessor :emailAddress
    # @attr [String] FullName
    attr_accessor :FullName

    # Human-readable accessors
    alias_method :email_address,         :emailAddress
    alias_method :email_address=,        :emailAddress=
    alias_method :full_name,             :FullName
    alias_method :full_name=,            :FullName=

  end # Document::Annotation::Reviewer
end # GroupDocs

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
groupdocs-1.1.0	lib/groupdocs/document/annotation/reviewer.rb