Module: GroupDocs

Defined in:
lib/groupdocs/document/style.rb,
lib/groupdocs.rb,
lib/groupdocs/job.rb,
lib/groupdocs/post.rb,
lib/groupdocs/user.rb,
lib/groupdocs/errors.rb,
lib/groupdocs/storage.rb,
lib/groupdocs/version.rb,
lib/groupdocs/document.rb,
lib/groupdocs/signature.rb,
lib/groupdocs/api/entity.rb,
lib/groupdocs/datasource.rb,
lib/groupdocs/api/request.rb,
lib/groupdocs/storage/file.rb,
lib/groupdocs/subscription.rb,
lib/groupdocs/document/view.rb,
lib/groupdocs/questionnaire.rb,
lib/groupdocs/document/field.rb,
lib/groupdocs/signature/form.rb,
lib/groupdocs/signature/list.rb,
lib/groupdocs/signature/role.rb,
lib/groupdocs/storage/folder.rb,
lib/groupdocs/document/change.rb,
lib/groupdocs/document/editor.rb,
lib/groupdocs/signature/field.rb,
lib/groupdocs/storage/package.rb,
lib/groupdocs/datasource/field.rb,
lib/groupdocs/storage/provider.rb,
lib/groupdocs/document/metadata.rb,
lib/groupdocs/signature/contact.rb,
lib/groupdocs/document/rectangle.rb,
lib/groupdocs/questionnaire/page.rb,
lib/groupdocs/signature/envelope.rb,
lib/groupdocs/signature/template.rb,
lib/groupdocs/subscription/limit.rb,
lib/groupdocs/document/annotation.rb,
lib/groupdocs/signature/recipient.rb,
lib/groupdocs/api/helpers/url_helper.rb,
lib/groupdocs/questionnaire/question.rb,
lib/groupdocs/signature/envelope/log.rb,
lib/groupdocs/api/helpers/mime_helper.rb,
lib/groupdocs/api/helpers/path_helper.rb,
lib/groupdocs/api/helpers/rest_helper.rb,
lib/groupdocs/questionnaire/collector.rb,
lib/groupdocs/questionnaire/execution.rb,
lib/groupdocs/signature/field/location.rb,
lib/groupdocs/api/helpers/status_helper.rb,
lib/groupdocs/document/annotation/reply.rb,
lib/groupdocs/questionnaire/style/title.rb,
lib/groupdocs/document/annotation/marker.rb,
lib/groupdocs/api/helpers/accessor_helper.rb,
lib/groupdocs/api/helpers/byte_flag_helper.rb,
lib/groupdocs/document/annotation/reviewer.rb,
lib/groupdocs/questionnaire/collector_style.rb,
lib/groupdocs/questionnaire/question/answer.rb,
lib/groupdocs/questionnaire/style/base_font.rb,
lib/groupdocs/api/helpers/access_mode_helper.rb,
lib/groupdocs/api/helpers/credentials_helper.rb,
lib/groupdocs/signature/shared/entity_fields.rb,
lib/groupdocs/signature/shared/field_methods.rb,
lib/groupdocs/signature/shared/entity_methods.rb,
lib/groupdocs/api/helpers/access_rights_helper.rb,
lib/groupdocs/questionnaire/question/conditions.rb,
lib/groupdocs/signature/shared/document_methods.rb,
lib/groupdocs/signature/shared/resource_methods.rb,
lib/groupdocs/questionnaire/style/question_title.rb,
lib/groupdocs/signature/shared/recipient_methods.rb,
lib/groupdocs/api/helpers/signature_public_helper.rb

Overview

added in release 1.7.0

Defined Under Namespace

Modules: Api, Storage Classes: BadResponseError, DataSource, Document, Job, NoClientIdError, NoPrivateKeyError, Post, Questionnaire, Signature, Subscription, UnsupportedMethodError, User

Constant Summary collapse

VERSION = 
'1.8.1'

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 ⇒ String

Returns version of API.

Returns:

  • (String) —

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



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:



57
58
59
 
# File 'lib/groupdocs.rb', line 57

def configure(&blk)
  yield self
end