Class: Onlyoffice::DocsIntegrationSdk::DocumentServer::Client::ConversionService::Request

Inherits:

T::Struct

• Object
• T::Struct
• Onlyoffice::DocsIntegrationSdk::DocumentServer::Client::ConversionService::Request

Extended by:

T::Sig

Defined in:

lib/onlyoffice/docs_integration_sdk/document_server/client/conversion.rb

Overview

Request is a class that represents the request options for the conversion service.

Since:

• 0.1.0

Defined Under Namespace

Classes: Delimiter, DocumentLayout, DocumentRenderer, Pdf, SpreadsheetLayout, Thumbnail, Watermark

Instance Attribute Summary

• #async ⇒ Boolean^?
• #code_page ⇒ Integer^?
• #delimiter ⇒ Delimiter^?
• #document_layout ⇒ DocumentLayout^?
• #document_renderer ⇒ DocumentRenderer^?
• #filetype ⇒ String^?
• #key ⇒ String^?
• #outputtype ⇒ String^?
• #password ⇒ String^?
• #pdf ⇒ Pdf^?
• #region ⇒ String^?
• #spreadsheet_layout ⇒ SpreadsheetLayout^?
• #thumbnail ⇒ Thumbnail^?
• #title ⇒ String^?
• #url ⇒ String^?
• #watermark ⇒ Watermark^?

Class Method Summary

• .from_hash(hash, strict = nil) ⇒ Request

Instance Method Summary

• #initialize(async: nil, code_page: nil, delimiter: nil, document_layout: nil, document_renderer: nil, filetype: nil, key: nil, outputtype: nil, password: nil, pdf: nil, region: nil, spreadsheet_layout: nil, thumbnail: nil, title: nil, url: nil, watermark: nil) ⇒ void constructor

Constructor Details

#initialize(async: nil, code_page: nil, delimiter: nil, document_layout: nil, document_renderer: nil, filetype: nil, key: nil, outputtype: nil, password: nil, pdf: nil, region: nil, spreadsheet_layout: nil, thumbnail: nil, title: nil, url: nil, watermark: nil) ⇒ void

Parameters:

• async (Boolean, nil) (defaults to: nil) —

  @since 0.1.0

• code_page (Integer, nil) (defaults to: nil) —

  @since 0.1.0

• delimiter (Delimiter, nil) (defaults to: nil) —

  @since 0.1.0

• document_layout (DocumentLayout, nil) (defaults to: nil) —

  @since 0.1.0

• document_renderer (DocumentRenderer, nil) (defaults to: nil) —

  @since 0.1.0

• filetype (String, nil) (defaults to: nil) —

  @since 0.1.0

• key (String, nil) (defaults to: nil) —

  @since 0.1.0

• outputtype (String, nil) (defaults to: nil) —

  @since 0.1.0

• password (String, nil) (defaults to: nil) —

  @since 0.1.0

• pdf (Pdf, nil) (defaults to: nil) —

  @since 0.1.0

• region (String, nil) (defaults to: nil) —

  @since 0.1.0

• spreadsheet_layout (SpreadsheetLayout, nil) (defaults to: nil) —

  @since 0.1.0

• thumbnail (Thumbnail, nil) (defaults to: nil) —

  @since 0.1.0

• title (String, nil) (defaults to: nil) —

  @since 0.1.0

• url (String, nil) (defaults to: nil) —

  @since 0.1.0

• watermark (Watermark, nil) (defaults to: nil) —

  @since 0.1.0

# File ''

prop :async, T.nilable(T::Boolean), name: "async"
prop :code_page, T.nilable(Integer), name: "codePage"
prop :delimiter, T.nilable(Delimiter), name: "delimiter"
prop :document_layout, T.nilable(DocumentLayout), name: "documentLayout"
prop :document_renderer, T.nilable(DocumentRenderer), name: "documentRenderer"
prop :filetype, T.nilable(String), name: "filetype"
prop :key, T.nilable(String), name: "key"
prop :outputtype, T.nilable(String), name: "outputtype"
prop :password, T.nilable(String), name: "password"
prop :pdf, T.nilable(Pdf), name: "pdf"
prop :region, T.nilable(String), name: "region"
prop :spreadsheet_layout, T.nilable(SpreadsheetLayout), name: "spreadsheetLayout"
prop :thumbnail, T.nilable(Thumbnail), name: "thumbnail"
prop :title, T.nilable(String), name: "title"
prop :url, T.nilable(String), name: "url"
prop :watermark, T.nilable(Watermark), name: "watermark"

Instance Attribute Details

#async ⇒ Boolean^?

Returns:

• (Boolean, nil)

Since:

• 0.1.0

# File ''

prop :async, T.nilable(T::Boolean), name: "async"

#code_page ⇒ Integer^?

Returns:

• (Integer, nil)

Since:

• 0.1.0

# File ''

prop :code_page, T.nilable(Integer), name: "codePage"

#delimiter ⇒ Delimiter^?

Returns:

• (Delimiter, nil)

Since:

• 0.1.0

# File ''

prop :delimiter, T.nilable(Delimiter), name: "delimiter"

#document_layout ⇒ DocumentLayout^?

Returns:

• (DocumentLayout, nil)

Since:

• 0.1.0

# File ''

prop :document_layout, T.nilable(DocumentLayout), name: "documentLayout"

#document_renderer ⇒ DocumentRenderer^?

Returns:

• (DocumentRenderer, nil)

Since:

• 0.1.0

# File ''

prop :document_renderer, T.nilable(DocumentRenderer), name: "documentRenderer"

#filetype ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :filetype, T.nilable(String), name: "filetype"

#key ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :key, T.nilable(String), name: "key"

#outputtype ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :outputtype, T.nilable(String), name: "outputtype"

#password ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :password, T.nilable(String), name: "password"

#pdf ⇒ Pdf^?

Returns:

• (Pdf, nil)

Since:

• 0.1.0

# File ''

prop :pdf, T.nilable(Pdf), name: "pdf"

#region ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :region, T.nilable(String), name: "region"

#spreadsheet_layout ⇒ SpreadsheetLayout^?

Returns:

• (SpreadsheetLayout, nil)

Since:

• 0.1.0

# File ''

prop :spreadsheet_layout, T.nilable(SpreadsheetLayout), name: "spreadsheetLayout"

#thumbnail ⇒ Thumbnail^?

Returns:

• (Thumbnail, nil)

Since:

• 0.1.0

# File ''

prop :thumbnail, T.nilable(Thumbnail), name: "thumbnail"

#title ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :title, T.nilable(String), name: "title"

#url ⇒ String^?

Returns:

• (String, nil)

Since:

• 0.1.0

# File ''

prop :url, T.nilable(String), name: "url"

#watermark ⇒ Watermark^?

Returns:

• (Watermark, nil)

Since:

• 0.1.0

# File ''

prop :watermark, T.nilable(Watermark), name: "watermark"

Class Method Details

.from_hash(hash, strict = nil) ⇒ Request

Parameters:

• hash (T.untyped)
• strict (T.untyped) (defaults to: nil)

Returns:

• (Request)

Since:

• 0.1.0

# File 'lib/onlyoffice/docs_integration_sdk/document_server/client/conversion.rb', line 407

def self.from_hash(hash, strict = nil)
  super(hash, strict)
end