ListFoldersOptions
in package
ListFoldersOptions Class Doc Comment
Tags
Table of Contents
- $cloud_storage_folder_path : string|null
- $cloud_storage_folder_path A comma separated list of folder IDs included in the request.
- $count : string|null
- $count An optional value that sets how many items are included in the response. The default setting for this is 25.
- $order : string|null
- $order An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
- $order_by : string|null
- $order_by An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
- $search_text : string|null
- $search_text
- $start_position : string|null
- $start_position Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.
- getCloudStorageFolderPath() : string|null
- Gets cloud_storage_folder_path
- getCount() : string|null
- Gets count
- getOrder() : string|null
- Gets order
- getOrderBy() : string|null
- Gets order_by
- getSearchText() : string|null
- Gets search_text
- getStartPosition() : string|null
- Gets start_position
- setCloudStorageFolderPath() : self
- Sets cloud_storage_folder_path
- setCount() : self
- Sets count
- setOrder() : self
- Sets order
- setOrderBy() : self
- Sets order_by
- setSearchText() : self
- Sets search_text
- setStartPosition() : self
- Sets start_position
Properties
$cloud_storage_folder_path
$cloud_storage_folder_path A comma separated list of folder IDs included in the request.
protected
string|null
$cloud_storage_folder_path
= null
$count
$count An optional value that sets how many items are included in the response. The default setting for this is 25.
protected
string|null
$count
= null
$order
$order An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
protected
string|null
$order
= null
$order_by
$order_by An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
protected
string|null
$order_by
= null
$search_text
$search_text
protected
string|null
$search_text
= null
$start_position
$start_position Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.
protected
string|null
$start_position
= null
Methods
getCloudStorageFolderPath()
Gets cloud_storage_folder_path
public
getCloudStorageFolderPath() : string|null
Return values
string|null —getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getOrder()
Gets order
public
getOrder() : string|null
Return values
string|null —getOrderBy()
Gets order_by
public
getOrderBy() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —setCloudStorageFolderPath()
Sets cloud_storage_folder_path
public
setCloudStorageFolderPath(string|null $cloud_storage_folder_path) : self
Parameters
- $cloud_storage_folder_path : string|null
-
A comma separated list of folder IDs included in the request.
Return values
self —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
An optional value that sets how many items are included in the response. The default setting for this is 25.
Return values
self —setOrder()
Sets order
public
setOrder(string|null $order) : self
Parameters
- $order : string|null
-
An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order
Return values
self —setOrderBy()
Sets order_by
public
setOrderBy(string|null $order_by) : self
Parameters
- $order_by : string|null
-
An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name
Return values
self —setSearchText()
Sets search_text
public
setSearchText(string|null $search_text) : self
Parameters
- $search_text : string|null
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.