Class: PoliPage::DocumentPreviewResult

Inherits:

Data

• Object
• Data
• PoliPage::DocumentPreviewResult

Defined in:

lib/poli_page/models/document_preview_result.rb

Overview

Return value of ‘client.documents.preview`. Distinct from `PoliPage::PreviewResult`: this carries `page_count` (NOT `total_pages`) because the documents.preview endpoint exposes the page count via the `X-Document-Page-Count` response header on a `text/html` body (sdk-ruby-plan.md §13 Phase 4; mirrors Node `documents.ts:75-77`).

Instance Attribute Summary

• #html ⇒ Object readonly

  Returns the value of attribute html.

• #page_count ⇒ Object readonly

  Returns the value of attribute page_count.

Instance Attribute Details

#html ⇒ Object (readonly)

Returns the value of attribute html

Returns:

• (Object) —

  the current value of html

# File 'lib/poli_page/models/document_preview_result.rb', line 9

def html
  @html
end

#page_count ⇒ Object (readonly)

Returns the value of attribute page_count

Returns:

• (Object) —

  the current value of page_count

# File 'lib/poli_page/models/document_preview_result.rb', line 9

def page_count
  @page_count
end