Class: AsposeWordsCloud::UpdateRunRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb

Overview

Request model for update_run operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, run, paragraph_path, index, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil) ⇒ UpdateRunRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • run —

    Run data.

  • paragraph_path —

    Path to parent paragraph.

  • index —

    Object index.

  • 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 for opening an encrypted document.

  • dest_file_name (defaults to: nil) —

    Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.

  • revision_author (defaults to: nil) —

    Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  • revision_date_time (defaults to: nil) —

    The date and time to use for revisions.



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

def initialize(name, run, paragraph_path, index, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil)
   self.name = name
   self.run = run
   self.paragraph_path = paragraph_path
   self.index = index
   self.folder = folder
   self.storage = storage
   self.load_encoding = load_encoding
   self.password = password
   self.dest_file_name = dest_file_name
   self.revision_author = revision_author
   self.revision_date_time = revision_date_time
end

Instance Attribute Details

#dest_file_name ⇒ Object

Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



52
53
54
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 52

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 44

def folder
  @folder
end

#index ⇒ Object

Object index.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 42

def index
  @index
end

#load_encoding ⇒ Object

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



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 48

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 36

def name
  @name
end

#paragraph_path ⇒ Object

Path to parent paragraph.



40
41
42
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 40

def paragraph_path
  @paragraph_path
end

#password ⇒ Object

Password for opening an encrypted document.



50
51
52
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 50

def password
  @password
end

#revision_author ⇒ Object

Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 54

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



56
57
58
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 56

def revision_date_time
  @revision_date_time
end

#run ⇒ Object

Run data.



38
39
40
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 38

def run
  @run
end

#storage ⇒ Object

Original document storage.



46
47
48
 
# File 'lib/aspose_words_cloud/models/requests/UpdateRunRequest.rb', line 46

def storage
  @storage
end