Class: DocuSign_eSign::ListWorkspaceFolderItemsOptions
- Inherits:
-
Object
- Object
- DocuSign_eSign::ListWorkspaceFolderItemsOptions
- Defined in:
- lib/docusign_esign/api/workspaces_api.rb
Instance Attribute Summary collapse
-
#count ⇒ Object
The maximum number of results to be returned by this request.
-
#include_files ⇒ Object
When set to true, file information is returned in the response along with folder information.
-
#include_sub_folders ⇒ Object
When set to true, information about the sub-folders of the current folder is returned.
-
#include_thumbnails ⇒ Object
When set to true, thumbnails are returned as part of the response.
-
#include_user_detail ⇒ Object
Set to true to return extended details about the user.
-
#start_position ⇒ Object
The position within the total result set from which to start returning values.
-
#workspace_user_id ⇒ Object
If set, then the results are filtered to those associated with the specified userId.
Class Method Summary collapse
Instance Attribute Details
#count ⇒ Object
The maximum number of results to be returned by this request.
52 53 54 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 52 def count @count end |
#include_files ⇒ Object
When set to true, file information is returned in the response along with folder information. The default is false.
55 56 57 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 55 def include_files @include_files end |
#include_sub_folders ⇒ Object
When set to true, information about the sub-folders of the current folder is returned. The default is false.
58 59 60 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 58 def include_sub_folders @include_sub_folders end |
#include_thumbnails ⇒ Object
When set to true, thumbnails are returned as part of the response. The default is false.
61 62 63 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 61 def include_thumbnails @include_thumbnails end |
#include_user_detail ⇒ Object
Set to true to return extended details about the user. The default is false.
64 65 66 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 64 def include_user_detail @include_user_detail end |
#start_position ⇒ Object
The position within the total result set from which to start returning values.
67 68 69 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 67 def start_position @start_position end |
#workspace_user_id ⇒ Object
If set, then the results are filtered to those associated with the specified userId.
70 71 72 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 70 def workspace_user_id @workspace_user_id end |
Class Method Details
.default ⇒ Object
72 73 74 |
# File 'lib/docusign_esign/api/workspaces_api.rb', line 72 def self.default @@default ||= ListWorkspaceFolderItemsOptions.new end |