azure-storage-file\src\File\Models\ListDirectoriesAndFilesOptions.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions

Table of Contents

LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2017 Microsoft Corporation
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php
Package: MicrosoftAzure\Storage\File\Models

\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions
jump to top

Package: MicrosoftAzure\Storage\File\Models

The options of listing directories and files.

Parent(s): \MicrosoftAzure\Storage\File\Models\FileServiceOptions < \MicrosoftAzure\Storage\Common\Models\ServiceOptions
Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2017 Microsoft Corporation
Inherited_from: \MicrosoftAzure\Storage\File\Models\FileServiceOptions
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php

Methods

__construct( $options = null) : void

inherited

Initialize the properties to default value.

Inherited from:

Parameters

Name	Type	Description
$options

generateRequestOptions(array $options) : array

inherited

Generate request options using the input options and saved properties.

Inherited from:

Parameters

Name	Type	Description
$options	array	The options to be merged for the request options.

Returns

Type	Description
array

getContinuationToken() : \MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken

inherited

Getter for continuationToken

Inherited from:

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken

getDecodeContent() : boolean

inherited

Gets the decodeContent value

Inherited from:

Returns

Type	Description
boolean

getIsStreaming() : boolean

inherited

Gets the isStreaming value

Inherited from:

Returns

Type	Description
boolean

getLocation() : string

inherited

Gets for location for previous request.

Inherited from:

Returns

Type	Description
string

getLocationMode() : string

inherited

Gets the locationMode value

Inherited from:

Returns

Type	Description
string

getMaxResults() : string

Gets max results which specifies the maximum number of directories and files to return.

If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items. If the parameter is set to a value less than or equal to zero, the server will return status code 400 (Bad Request).

Returns

Type	Description
string

getMiddlewareStack() : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

inherited

Gets the middleware stack

Inherited from:

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

getMiddlewares() : array

inherited

Gets the middlewares.

Inherited from:

Returns

Type	Description
array

getNextMarker() : string

inherited

Gets the next marker to list/query items.

Inherited from:

Returns

Type	Description
string

getNumberOfConcurrency() : integer

inherited

Gets the number of concurrency value

Inherited from:

Returns

Type	Description
integer

getPrefix() : string

Get the prefix.

Returns

Type	Description
string

getTimeout() : string

inherited

Gets the timeout value

Inherited from:

Returns

Type	Description
string

pushMiddleware(callable | \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware $middleware) : void

inherited

Push a middleware into the middlewares.

Inherited from:

Parameters

Name	Type	Description
$middleware	callable \| \MicrosoftAzure\Storage\Common\Middlewares\IMiddleware	middleware to be pushed.

setContinuationToken(\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken | null $continuationToken = null) : void

inherited

Setter for continuationToken

Inherited from:

Parameters

Name	Type	Description
$continuationToken	\MicrosoftAzure\Storage\Common\Models\MarkerContinuationToken \| null	the continuation token to be set.

setDecodeContent(boolean $decodeContent) : void

inherited

Sets decodeContent.

Inherited from:

Parameters

Name	Type	Description
$decodeContent	boolean	value.

setIsStreaming(boolean $isStreaming) : void

inherited

Sets isStreaming.

Inherited from:

Parameters

Name	Type	Description
$isStreaming	boolean	value.

setLocationMode(string $locationMode) : void

inherited

Sets locationMode.

Inherited from:

Parameters

Name	Type	Description
$locationMode	string	value.

setMarker( $marker) : void

inherited

Inherited from:

Parameters

Name	Type	Description
$marker

setMaxResults(string $maxResults) : void

Sets max results which specifies the maximum number of directories and files to return.

Parameters

Name	Type	Description
$maxResults	string	value.

setMiddlewareStack(\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack $middlewareStack) : void

inherited

Sets the middleware stack.

Inherited from:

Parameters

Name	Type	Description
$middlewareStack	\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack	value.

setMiddlewares(array $middlewares) : void

inherited

Sets middlewares.

Inherited from:

Parameters

Name	Type	Description
$middlewares	array	value.

setNumberOfConcurrency(integer $numberOfConcurrency) : void

inherited

Sets number of concurrency.

Inherited from:

Parameters

Name	Type	Description
$numberOfConcurrency	integer	value.

setPrefix(string $prefix) : void

Set a specified prefix.

Parameters

Name	Type	Description
$prefix	string

setTimeout(string $timeout) : void

inherited

Sets timeout.

Inherited from:

Parameters

Name	Type	Description
$timeout	string	value.

azure-storage-file\src\File\Models\ListDirectoriesAndFilesOptions.php

\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptionsjump to top

Methods

\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions
jump to top