Class: GroupDocs::Signature::Recipient

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

Constant Summary collapse

STATUSES =
{
  none:     -1,
  waiting:   0,
  notified:  1,
  delegated: 2,
  rejected:  3,
  signed:    4,
}

Instance Attribute Summary collapse

Method Summary

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Constructor Details

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

Instance Attribute Details

#emailObject



16
17
18
# File 'lib/groupdocs/signature/recipient.rb', line 16

def email
  @email
end

#firstNameObject Also known as: first_name



18
19
20
# File 'lib/groupdocs/signature/recipient.rb', line 18

def firstName
  @firstName
end

#idObject



14
15
16
# File 'lib/groupdocs/signature/recipient.rb', line 14

def id
  @id
end

#lastNameObject Also known as: last_name



20
21
22
# File 'lib/groupdocs/signature/recipient.rb', line 20

def lastName
  @lastName
end

#nicknameObject



22
23
24
# File 'lib/groupdocs/signature/recipient.rb', line 22

def nickname
  @nickname
end

#orderObject



26
27
28
# File 'lib/groupdocs/signature/recipient.rb', line 26

def order
  @order
end

#roleIdObject Also known as: role_id



24
25
26
# File 'lib/groupdocs/signature/recipient.rb', line 24

def roleId
  @roleId
end

#statusSymbol

Converts status to human-readable format.

Returns:

  • (Symbol)


28
29
30
# File 'lib/groupdocs/signature/recipient.rb', line 28

def status
  @status
end