Class: GroupDocs::Signature::Role

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

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

#canAnnotate ⇒ Object Also known as: can_annotate 



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

def canAnnotate
  @canAnnotate
end

#canDelegate ⇒ Object Also known as: can_delegate 



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

def canDelegate
  @canDelegate
end

#canEdit ⇒ Object Also known as: can_edit 



33
34
35
 
# File 'lib/groupdocs/signature/role.rb', line 33

def canEdit
  @canEdit
end

#canSign ⇒ Object Also known as: can_sign 



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

def canSign
  @canSign
end

#id ⇒ Object 



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

def id
  @id
end

#name ⇒ Object 



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

def name
  @name
end

Class Method Details

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

Returns array of predefined roles.

Parameters:

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

    Hash of options

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

    Access credentials

Options Hash (options):

  • :id (String) —

    Filter by identifier

Options Hash (access):

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

Returns:

  • (Array<GroupDocs::Signature::role>) 


14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/groupdocs/signature/role.rb', line 14

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

  json[:roles].map do |role|
    new(role)
  end
end

Instance Method Details

#can_annotate? ⇒ Boolean

Returns true if role can annotate.

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/groupdocs/signature/role.rb', line 71

def can_annotate?
  can_annotate == 1
end

#can_delegate? ⇒ Boolean

Returns true if role can delegate.

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/groupdocs/signature/role.rb', line 79

def can_delegate?
  can_delegate == 1
end

#can_edit? ⇒ Boolean

Returns true if role can edit.

Returns:

  • (Boolean) 


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

def can_edit?
  can_edit == 1
end

#can_sign? ⇒ Boolean

Returns true if role can sign.

Returns:

  • (Boolean) 


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

def can_sign?
  can_sign == 1
end