1. class
  2. Cloudinary
  3. \
  4. Api
  5. \
  6. Search
  7. \
  8. SearchFoldersApi

SearchFoldersApi

class SearchFoldersApi extends SearchApi

Class SearchFoldersApi

The Cloudinary API folders search method allows you fine control on filtering and retrieving information on all the folders in your cloud with the help of query expressions in a Lucene-like query language.

Methods

__construct(mixed $configuration = null)

SearchFoldersApi constructor.

endpoint(string $endpoint)

Sets the Search API endpoint.

executeAsync()

Executes the search API request asynchronously.

execute()

Executes the search API request.

toUrl(int $ttl = null, string $nextCursor = null)

Creates a signed Search URL that can be used on the client side.

jsonSerialize()

No description

Details

__construct(mixed $configuration = null)

SearchFoldersApi constructor.

Parameters

Name Type Description
$configuration mixed

$this endpoint(string $endpoint)

Sets the Search API endpoint.

Parameters

Name Type Description
$endpoint string The endpoint for the Search API.

Return Value

$this

PromiseInterface executeAsync()

Executes the search API request asynchronously.

Return Value

PromiseInterface

ApiResponse execute()

Executes the search API request.

Return Value

ApiResponse

Exceptions

GeneralError

string toUrl(int $ttl = null, string $nextCursor = null)

Creates a signed Search URL that can be used on the client side.

Parameters

Name Type Description
$ttl int The time to live in seconds.
$nextCursor string Starting position.

Return Value

string The resulting search URL.

jsonSerialize()

Constants

ASSETS

FOLDERS