Module: GroupDocs::Storage

Defined in:
lib/groupdocs/storage.rb,
lib/groupdocs/storage/file.rb,
lib/groupdocs/storage/folder.rb,
lib/groupdocs/storage/package.rb,
lib/groupdocs/storage/provider.rb

Defined Under Namespace

Classes: File, Folder, Package, Provider

Class Method Summary collapse

Class Method Details

.info!(access = {}) ⇒ Hash

Changed in release 1.5.8

Returns hash of information about user’s storage.

Examples:

GroupDocs::Storage.info!
#=> { total_space: "1024 MB", available_space: "1020 MB", document_credits: 5000, available_credits: 4964 }

Parameters:

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

    Access credentials

Options Hash (access):

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

Returns:

  • (Hash) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/groupdocs/storage.rb', line 24

def self.info!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/storage/{{client_id}}'
  end.execute!

  {
    :total_space       => "#{json[:total_space] / 1048576} MB",
    :available_space   => "#{json[:avail_space] / 1048576} MB",
    :document_credits  => json[:doc_credits],
    :available_credits => json[:avail_credits],
    :maxViewingFileSize => json[:maxViewingFileSize]
  }
end