Class: GroupDocs::Post

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

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

Class Method Details

.compress!(options = {}) ⇒ Array

Compress by post.

Parameters:

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

    a customizable set of options

  • file_id (Hash) —

    a customizable set of options

  • archive (Hash) —

    a customizable set of options

Returns:

  • (Array) 


62
63
64
65
66
67
68
69
 
# File 'lib/groupdocs/post.rb', line 62

def self.compress!(options = {})
  api = Api::Request.new do |request|
    request[:method] = :POST
    request[:path] = '/post/file.compress'
  end
  api.add_params(options)
  api.execute!
end

.delete!(options = {}) ⇒ Array

Delete by post.

Parameters:

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

    a customizable set of options

  • user_id (Hash) —

    a customizable set of options

Returns:

  • (Array) 


29
30
31
32
33
34
35
36
 
# File 'lib/groupdocs/post.rb', line 29

def self.delete!(options = {})
  api = Api::Request.new do |request|
    request[:method] = :POST
    request[:path] = '/post/file.delete'
  end
  api.add_params(options)
  api.execute!
end

.delete_from_folder!(options = {}) ⇒ Array

Delete from folder by post.

Parameters:

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

    a customizable set of options

  • path (Hash) —

    a customizable set of options

Returns:

  • (Array) 


45
46
47
48
49
50
51
52
 
# File 'lib/groupdocs/post.rb', line 45

def self.delete_from_folder!(options = {})
  api = Api::Request.new do |request|
    request[:method] = :POST
    request[:path] = '/post/file.delete.in'
  end
  api.add_params(options)
  api.execute!
end

.rename!(options = {}) ⇒ Array

Rename by post.

Parameters:

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

    a customizable set of options

  • new_name (Hash) —

    a customizable set of options

  • user_id (Hash) —

    a customizable set of options

Returns:

  • (Array) 


13
14
15
16
17
18
19
20
 
# File 'lib/groupdocs/post.rb', line 13

def self.rename!(options = {})
  api = Api::Request.new do |request|
    request[:method] = :POST
    request[:path] = '/post/file.rename'
  end
  api.add_params(options)
  api.execute!
end