Class: GroupDocs::Questionnaire::Execution

Inherits:
Api::Entity
  • Object
show all
Includes:
Api::Helpers::Status
Defined in:
lib/groupdocs/questionnaire/execution.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

#approver ⇒ Object 



29
30
31
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 29

def approver
  @approver
end

#datasource_id ⇒ Object 



31
32
33
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 31

def datasource_id
  @datasource_id
end

#executive ⇒ Object 



27
28
29
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 27

def executive
  @executive
end

#guid ⇒ Object 



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

def guid
  @guid
end

#id ⇒ Object 



19
20
21
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 19

def id
  @id
end

#owner ⇒ Object 



25
26
27
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 25

def owner
  @owner
end

#questionnaire_id ⇒ Object 



21
22
23
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 21

def questionnaire_id
  @questionnaire_id
end

#questionnaire_name ⇒ Object 



23
24
25
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 23

def questionnaire_name
  @questionnaire_name
end

#status ⇒ Symbol

Converts status to human-readable format.

Returns:

  • (Symbol) 


33
34
35
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 33

def status
  @status
end

Class Method Details

.all!(access = {}) ⇒ Array<GroupDocs::Questionnaire::Execution>

Returns an array of all executions.

Parameters:

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

    Access credentials

Options Hash (access):

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

Returns:



14
15
16
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 14

def self.all!(access = {})
  Questionnaire.executions!(access)
end

Instance Method Details

#set_status!(status, access = {}) ⇒ Object

Updates status of execution on server.

Parameters:

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

    Access credentials

Options Hash (access):

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


65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 65

def set_status!(status, access = {})
  status = parse_status(status)

  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
    request[:request_body] = status
  end.execute!

  self.status = status
end

#update!(access = {}) ⇒ Object

Updates execution on server.

Parameters:

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

    Access credentials

Options Hash (access):

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


85
86
87
88
89
90
91
92
 
# File 'lib/groupdocs/questionnaire/execution.rb', line 85

def update!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
    request[:request_body] = to_hash
  end.execute!
end