Class: GroupDocsSignatureCloud::DeleteFolderRequest

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

Overview

Request model for delete_folder operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, storage_name = nil, recursive = nil) ⇒ DeleteFolderRequest

Initializes a new instance.

Parameters:

  • path —

    Folder path e.g. ‘/folder’

  • storage_name (defaults to: nil) —

    Storage name

  • recursive (defaults to: nil) —

    Enable to delete folders, subfolders and files



587
588
589
590
591
 
# File 'lib/groupdocs_signature_cloud/api/folder_api.rb', line 587

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

Instance Attribute Details

#path ⇒ Object

Folder path e.g. ‘/folder’



576
577
578
 
# File 'lib/groupdocs_signature_cloud/api/folder_api.rb', line 576

def path
  @path
end

#recursive ⇒ Object

Enable to delete folders, subfolders and files



580
581
582
 
# File 'lib/groupdocs_signature_cloud/api/folder_api.rb', line 580

def recursive
  @recursive
end

#storage_name ⇒ Object

Storage name



578
579
580
 
# File 'lib/groupdocs_signature_cloud/api/folder_api.rb', line 578

def storage_name
  @storage_name
end