This Gist contains Ruby examples of GroupDocs.Annotation Cloud

Annotation-Ruby

Annotation-Ruby

Annotation_Ruby_Delete_Image_Pages.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Delete Images Cache of Document Pages.
    def delete_pages
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
      @password=nil
            
      @image_pages_api = GroupDocsAnnotationCloud::ImagePagesApi.from_config(@config)
      request = GroupDocsAnnotationCloud::DeletePagesRequest.new(@filename,@foldername)
      
      #Delete previously generated images for document pages
      response = @image_pages_api.delete_pages request
      puts 'completed'
    end

Annotation_Ruby_Generate_Pages.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby
# Generate Images of Document Pages.
    def post_generate_pages
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
      @password=nil
      
      @image_pages_api = GroupDocsAnnotationCloud::ImagePagesApi.from_config(@config)
      request = GroupDocsAnnotationCloud::PostPagesRequest.new(@filename, @foldername,@password)
      
      # Generate Images of Document Pages.
      response = @image_pages_api.post_pages request
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Delete_Annotation.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Remove annotations from document.
    def delete_annotation
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
            
      @annotation_api = GroupDocsAnnotationCloud::AnnotationApi.from_config(@config)     
      request = GroupDocsAnnotationCloud::DeleteCleanDocumentRequest.new(@filename,@foldername)
      
      # Remove annotations from document.
      response = @annotation_api.delete_clean_document request 
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Export_Annotation.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Export Annotation and get Document as Stream.
    def put_export
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil      
      
      @annotation_api = GroupDocsAnnotationCloud::AnnotationApi.from_config(@config)
      reply1 = GroupDocsAnnotationCloud::AnnotationReplyInfo.new(:Message => "reply text", :RepliedOn => Time.now, :UserName => "Admin")
      reply2 = GroupDocsAnnotationCloud::AnnotationReplyInfo.new(:Message => "reply2 text", :RepliedOn => Time.now, :UserName => "Commentator")
      replies = [reply1, reply2]
      @textAnnotation = GroupDocsAnnotationCloud::AnnotationInfo.new(
        :AnnotationPosition => GroupDocsAnnotationCloud::Point.new(:X => 852.0, :Y => 154.31),
        :Box => GroupDocsAnnotationCloud::Rectangle.new(:X => 173.29, :Y => 154.31, :Width => 142.5, :Height => 9.0),
        :PageNumber => 0,
        :Replies => replies,
        :SvgPath => "[{\"x\":173.2986,\"y\":687.5769},{\"x\":315.7985,\"y\":687.5769},{\"x\":173.2986,\"y\":678.5769},{\"x\":315.7985,\"y\":678.5769}]",
        :Type => "TextUnderline",
        :CreatorName => "Anonym A."
      )
      annotations = [@textAnnotation]
      request = GroupDocsAnnotationCloud::PutExportRequest.new(@filename, annotations, @foldername);
      
      # Export Annotation and get Document as Stream.
      response = @annotation_api.put_export(request);
      puts response.length
      puts 'completed'
    end

Annotation_Ruby_Get_Image_Page.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Get Link to Image of Specific Page.
    def get_page_link
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
      @password=nil
      @pagenum='0'
      
      @image_pages_api = GroupDocsAnnotationCloud::ImagePagesApi.from_config(@config)
      request = GroupDocsAnnotationCloud::GetPageRequest.new(@filename,@foldername,@password)
      request.page_number = 0
      
      # Get Link to Image of Specific Page.
      response = @image_pages_api.get_page request
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Image_Pages.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Get Links to Images of the Document Pages.
    def get_pages_link
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
            
      @image_pages_api = GroupDocsAnnotationCloud::ImagePagesApi.from_config(@config)
      request = GroupDocsAnnotationCloud::GetPagesRequest.new(@filename, @foldername)
      # Get Links to Images of the Document Pages.
      response = @image_pages_api.get_pages request
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Import_Annotation.rb

# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby
# Extracts annotations from document.
    def get_import
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil      
      
      @annotation_api = GroupDocsAnnotationCloud::AnnotationApi.from_config(@config)     
      request = GroupDocsAnnotationCloud::GetImportRequest.new(@filename,@foldername)
      # Extracts annotations from document.
      response = @annotation_api.get_import request
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Info.rb

#TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
##For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby
# Retrieves document information.
    def test_get_info
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'Annotated.pdf'
      @foldername = nil
      @password=nil
      
      @image_info_api = GroupDocsAnnotationCloud::ImageInfoApi.from_config(@config)
      request = GroupDocsAnnotationCloud::GetInfoRequest.new(@filename, @foldername,@password)
      
      # Retrieves document information.
      response = @image_info_api.get_info request
      puts response.name
      puts 'completed'
    end

Annotation_Ruby_Get_Render_Storage.rb

#TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
##For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby
# Retrieves document as PDF.
    def get_pdf
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'one-page.docx'
      @foldername = nil
      
      @pdffile_api = GroupDocsAnnotationCloud::PdfFileApi.from_config(@config)
      request = GroupDocsAnnotationCloud::GetPdfRequest.new(@filename,@foldername)
      
      # Retrieves document as PDF.
      response = @pdffile_api.get_pdf request
      puts response
      puts 'completed'
    end

Annotation_Ruby_Get_Render_Stream.rb

#TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
#For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby

# Download document as PDF.
    def get_pdf
      @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY)
      @config.api_base_url = Utils::API_BASE_URL
      @filename = 'one-page.docx'
      @foldername = nil
            
      @pdffile_api = GroupDocsAnnotationCloud::PdfFileApi.from_config(@config)
      request = GroupDocsAnnotationCloud::GetPdfStreamRequest.new(@filename,@foldername)
      
      # Download document as PDF.  
      response = @pdffile_api.get_pdf_stream request
      puts response
      puts 'completed'
    end