Class: GroupDocsSignatureCloud::CopyFileRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/api/file_api.rb

Overview

Request model for copy_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil) ⇒ CopyFileRequest

Initializes a new instance.

Parameters:

  • src_path

    Source file path e.g. ‘/folder/file.ext’

  • dest_path

    Destination file path

  • src_storage_name (defaults to: nil)

    Source storage name

  • dest_storage_name (defaults to: nil)

    Destination storage name

  • version_id (defaults to: nil)

    File version ID to copy



506
507
508
509
510
511
512
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 506

def initialize(src_path, dest_path, src_storage_name = nil, dest_storage_name = nil, version_id = nil)
   self.src_path = src_path
   self.dest_path = dest_path
   self.src_storage_name = src_storage_name
   self.dest_storage_name = dest_storage_name
   self.version_id = version_id
end

Instance Attribute Details

#dest_pathObject

Destination file path



491
492
493
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 491

def dest_path
  @dest_path
end

#dest_storage_nameObject

Destination storage name



495
496
497
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 495

def dest_storage_name
  @dest_storage_name
end

#src_pathObject

Source file path e.g. ‘/folder/file.ext’



489
490
491
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 489

def src_path
  @src_path
end

#src_storage_nameObject

Source storage name



493
494
495
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 493

def src_storage_name
  @src_storage_name
end

#version_idObject

File version ID to copy



497
498
499
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 497

def version_id
  @version_id
end