Module: GroupDocs

Defined in:
lib/groupdocs.rb,
lib/groupdocs/job.rb,
lib/groupdocs/user.rb,
lib/groupdocs/errors.rb,
lib/groupdocs/storage.rb,
lib/groupdocs/version.rb,
lib/groupdocs/document.rb,
lib/groupdocs/api/entity.rb,
lib/groupdocs/datasource.rb,
lib/groupdocs/api/request.rb,
lib/groupdocs/storage/file.rb,
lib/groupdocs/document/view.rb,
lib/groupdocs/questionnaire.rb,
lib/groupdocs/document/field.rb,
lib/groupdocs/storage/folder.rb,
lib/groupdocs/document/change.rb,
lib/groupdocs/storage/package.rb,
lib/groupdocs/datasource/field.rb,
lib/groupdocs/document/metadata.rb,
lib/groupdocs/extensions/lookup.rb,
lib/groupdocs/document/rectangle.rb,
lib/groupdocs/questionnaire/page.rb,
lib/groupdocs/document/annotation.rb,
lib/groupdocs/api/helpers/url_helper.rb,
lib/groupdocs/questionnaire/question.rb,
lib/groupdocs/api/helpers/path_helper.rb,
lib/groupdocs/api/helpers/rest_helper.rb,
lib/groupdocs/questionnaire/execution.rb,
lib/groupdocs/api/helpers/status_helper.rb,
lib/groupdocs/document/annotation/reply.rb,
lib/groupdocs/api/helpers/actions_helper.rb,
lib/groupdocs/questionnaire/question/answer.rb,
lib/groupdocs/api/helpers/access_mode_helper.rb,
lib/groupdocs/api/helpers/credentials_helper.rb

Defined Under Namespace

Modules: Api, Extensions, Storage Classes: BadResponseError, DataSource, Document, Job, NoClientIdError, NoPrivateKeyError, Questionnaire, UnsupportedMethodError, User

Constant Summary collapse

VERSION = 
'0.2.7'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_server ⇒ String

Returns hostname of API server.

Returns:

  • (String) —

    API hostname. Default one if it has not been explicitly set



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

def api_server
  @api_server
end

.api_version ⇒ Object 



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

def api_version
  @api_version
end

.client_id ⇒ Object 



17
18
19
 
# File 'lib/groupdocs.rb', line 17

def client_id
  @client_id
end

.private_key ⇒ Object 



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

def private_key
  @private_key
end

Class Method Details

.configure {|GroupDocs| ... } ⇒ Object

Calls block for configuration of GroupDocs.

Examples:

GroupDocs.configure do |groupdocs|
  groupdocs.client_id = '07aaaf95f8eb33a4'
  groupdocs.private_key = '5cb711b3a52ffc5d90ee8a0f79206f5a'
  groupdocs.api_server = 'https://api.groupdocs.com'
  groupdocs.api_version = '2.0'
end

Yields:



50
51
52
 
# File 'lib/groupdocs.rb', line 50

def configure(&blk)
  yield self
end