Method: AsposeWordsCloud::GetDocumentStatisticsRequest#initialize

Defined in:
lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb

#initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil) ⇒ GetDocumentStatisticsRequest

Initializes a new instance.

Parameters:

  • name —

    The filename of the input document.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.

  • encrypted_password (defaults to: nil) —

    Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.

  • include_comments (defaults to: nil) —

    The flag indicating whether to include comments from the WordCount. The default value is “false”.

  • include_footnotes (defaults to: nil) —

    The flag indicating whether to include footnotes from the WordCount. The default value is “false”.

  • include_text_in_shapes (defaults to: nil) —

    The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 71

def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil)
  self.name = name
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.encrypted_password = encrypted_password
  self.include_comments = include_comments
  self.include_footnotes = include_footnotes
  self.include_text_in_shapes = include_text_in_shapes
end