ListWorkspaceFolderItemsOptions
in package
ListWorkspaceFolderItemsOptions Class Doc Comment
Tags
Table of Contents
- $count : string|null
- $count The maximum number of results to be returned by this request.
- $include_files : string|null
- $include_files When set to **true**, file information is returned in the response along with folder information. The default is **false**.
- $include_sub_folders : string|null
- $include_sub_folders When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
- $include_thumbnails : string|null
- $include_thumbnails When set to **true**, thumbnails are returned as part of the response. The default is **false**.
- $include_user_detail : string|null
- $include_user_detail Set to **true** to return extended details about the user. The default is **false**.
- $start_position : string|null
- $start_position The position within the total result set from which to start returning values.
- $workspace_user_id : string|null
- $workspace_user_id If set, then the results are filtered to those associated with the specified userId.
- getCount() : string|null
- Gets count
- getIncludeFiles() : string|null
- Gets include_files
- getIncludeSubFolders() : string|null
- Gets include_sub_folders
- getIncludeThumbnails() : string|null
- Gets include_thumbnails
- getIncludeUserDetail() : string|null
- Gets include_user_detail
- getStartPosition() : string|null
- Gets start_position
- getWorkspaceUserId() : string|null
- Gets workspace_user_id
- setCount() : self
- Sets count
- setIncludeFiles() : self
- Sets include_files
- setIncludeSubFolders() : self
- Sets include_sub_folders
- setIncludeThumbnails() : self
- Sets include_thumbnails
- setIncludeUserDetail() : self
- Sets include_user_detail
- setStartPosition() : self
- Sets start_position
- setWorkspaceUserId() : self
- Sets workspace_user_id
Properties
$count
$count The maximum number of results to be returned by this request.
protected
string|null
$count
= null
$include_files
$include_files When set to **true**, file information is returned in the response along with folder information. The default is **false**.
protected
string|null
$include_files
= null
$include_sub_folders
$include_sub_folders When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**.
protected
string|null
$include_sub_folders
= null
$include_thumbnails
$include_thumbnails When set to **true**, thumbnails are returned as part of the response. The default is **false**.
protected
string|null
$include_thumbnails
= null
$include_user_detail
$include_user_detail Set to **true** to return extended details about the user. The default is **false**.
protected
string|null
$include_user_detail
= null
$start_position
$start_position The position within the total result set from which to start returning values.
protected
string|null
$start_position
= null
$workspace_user_id
$workspace_user_id If set, then the results are filtered to those associated with the specified userId.
protected
string|null
$workspace_user_id
= null
Methods
getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getIncludeFiles()
Gets include_files
public
getIncludeFiles() : string|null
Return values
string|null —getIncludeSubFolders()
Gets include_sub_folders
public
getIncludeSubFolders() : string|null
Return values
string|null —getIncludeThumbnails()
Gets include_thumbnails
public
getIncludeThumbnails() : string|null
Return values
string|null —getIncludeUserDetail()
Gets include_user_detail
public
getIncludeUserDetail() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getWorkspaceUserId()
Gets workspace_user_id
public
getWorkspaceUserId() : string|null
Return values
string|null —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
The maximum number of results to be returned by this request.
Return values
self —setIncludeFiles()
Sets include_files
public
setIncludeFiles(string|null $include_files) : self
Parameters
- $include_files : string|null
-
When set to true, file information is returned in the response along with folder information. The default is false.
Return values
self —setIncludeSubFolders()
Sets include_sub_folders
public
setIncludeSubFolders(string|null $include_sub_folders) : self
Parameters
- $include_sub_folders : string|null
-
When set to true, information about the sub-folders of the current folder is returned. The default is false.
Return values
self —setIncludeThumbnails()
Sets include_thumbnails
public
setIncludeThumbnails(string|null $include_thumbnails) : self
Parameters
- $include_thumbnails : string|null
-
When set to true, thumbnails are returned as part of the response. The default is false.
Return values
self —setIncludeUserDetail()
Sets include_user_detail
public
setIncludeUserDetail(string|null $include_user_detail) : self
Parameters
- $include_user_detail : string|null
-
Set to true to return extended details about the user. The default is false.
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
The position within the total result set from which to start returning values.
Return values
self —setWorkspaceUserId()
Sets workspace_user_id
public
setWorkspaceUserId(string|null $workspace_user_id) : self
Parameters
- $workspace_user_id : string|null
-
If set, then the results are filtered to those associated with the specified userId.