Class: WordsRubySdk::PutParagraphRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb

Overview

Request model for put_paragraph operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, paragraph, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, node_path = nil, insert_before_node = nil) ⇒ PutParagraphRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • paragraph —

    Paragraph data.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    File storage, which have to be used.

  • 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 name 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.

  • node_path (defaults to: nil) —

    Path to node which contains paragraphs.

  • insert_before_node (defaults to: nil) —

    Paragraph will be inserted before node with index.



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

def initialize(name, paragraph, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, node_path = nil, insert_before_node = nil)
   self.name = name
   self.paragraph = paragraph
   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
   self.node_path = node_path
   self.insert_before_node = insert_before_node
end

Instance Attribute Details

#dest_file_name ⇒ Object

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



48
49
50
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 48

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



40
41
42
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 40

def folder
  @folder
end

#insert_before_node ⇒ Object

Paragraph will be inserted before node with index.



56
57
58
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 56

def insert_before_node
  @insert_before_node
end

#load_encoding ⇒ Object

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



44
45
46
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 44

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



36
37
38
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 36

def name
  @name
end

#node_path ⇒ Object

Path to node which contains paragraphs.



54
55
56
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 54

def node_path
  @node_path
end

#paragraph ⇒ Object

Paragraph data.



38
39
40
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 38

def paragraph
  @paragraph
end

#password ⇒ Object

Password for opening an encrypted document.



46
47
48
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 46

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.



50
51
52
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 50

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



52
53
54
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 52

def revision_date_time
  @revision_date_time
end

#storage ⇒ Object

File storage, which have to be used.



42
43
44
 
# File 'lib/words_ruby_sdk/models/requests/PutParagraphRequest.rb', line 42

def storage
  @storage
end