Class: WordsRubySdk::PutFieldRequest
- Inherits:
-
Object
- Object
- WordsRubySdk::PutFieldRequest
- Defined in:
- lib/words_ruby_sdk/models/requests/PutFieldRequest.rb
Overview
Request model for put_field operation.
Instance Attribute Summary collapse
-
#dest_file_name ⇒ Object
Result name of the document after the operation.
-
#field ⇒ Object
Field data.
-
#folder ⇒ Object
Original document folder.
-
#insert_before_node ⇒ Object
Field will be inserted before node with id="nodeId".
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The document name.
-
#node_path ⇒ Object
Path to node, which contains collection of fields.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#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.
-
#revision_date_time ⇒ Object
The date and time to use for revisions.
-
#storage ⇒ Object
File storage, which have to be used.
Instance Method Summary collapse
-
#initialize(name, field, 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) ⇒ PutFieldRequest
constructor
Initializes a new instance.
Constructor Details
#initialize(name, field, 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) ⇒ PutFieldRequest
Initializes a new instance.
71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.rb', line 71 def initialize(name, field, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, = nil, revision_date_time = nil, node_path = nil, insert_before_node = nil) self.name = name self.field = field self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.dest_file_name = dest_file_name self. = 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/PutFieldRequest.rb', line 48 def dest_file_name @dest_file_name end |
#field ⇒ Object
Field data.
38 39 40 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.rb', line 38 def field @field end |
#folder ⇒ Object
Original document folder.
40 41 42 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.rb', line 40 def folder @folder end |
#insert_before_node ⇒ Object
Field will be inserted before node with id="nodeId".
56 57 58 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.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/PutFieldRequest.rb', line 44 def load_encoding @load_encoding end |
#name ⇒ Object
The document name.
36 37 38 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.rb', line 36 def name @name end |
#node_path ⇒ Object
Path to node, which contains collection of fields.
54 55 56 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.rb', line 54 def node_path @node_path end |
#password ⇒ Object
Password for opening an encrypted document.
46 47 48 |
# File 'lib/words_ruby_sdk/models/requests/PutFieldRequest.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/PutFieldRequest.rb', line 50 def @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/PutFieldRequest.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/PutFieldRequest.rb', line 42 def storage @storage end |