Class: GroupDocsSignatureCloud::DeleteFileRequest

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

Overview

Request model for delete_file operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, storage_name = nil, version_id = nil) ⇒ DeleteFileRequest

Initializes a new instance.

Parameters:

  • path

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

  • storage_name (defaults to: nil)

    Storage name

  • version_id (defaults to: nil)

    File version ID to delete



561
562
563
564
565
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 561

def initialize(path, storage_name = nil, version_id = nil)
   self.path = path
   self.storage_name = storage_name
   self.version_id = version_id
end

Instance Attribute Details

#pathObject

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



550
551
552
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 550

def path
  @path
end

#storage_nameObject

Storage name



552
553
554
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 552

def storage_name
  @storage_name
end

#version_idObject

File version ID to delete



554
555
556
# File 'lib/groupdocs_signature_cloud/api/file_api.rb', line 554

def version_id
  @version_id
end