Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet Class Reference

Inheritance diagram for Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet:

Public Member Functions
	__construct (string $projectKey, string $container, $body=null, array $headers=[], ClientInterface $client=null)
	mapFromResponse (?ResponseInterface $response, string $resultType=null)
	execute (array $options=[], string $resultType=null)
	executeAsync (array $options=[], string $resultType=null)
	withSort ($sort)
	withWhere ($where)
	withExpand ($expand)
	withPredicateVar (string $varName, $predicateVar)
	withLimit ($limit)
	withOffset ($offset)
	withWithTotal ($withTotal)
Public Member Functions inherited from Commercetools\Client\ApiRequest
	__construct (?ClientInterface $client, string $method, string $uri, array $headers=[], $body=null, string $version='1.1')
	withQueryParam (string $parameterName, $value)
	send (array $options=[])
	sendAsync (array $options=[])
	getClient ()
Public Member Functions inherited from Commercetools\Api\Client\Resource\Query
	withWhere (string $where)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Paging
	withLimit (int $limit)
	withOffset (int $offset)
	withWithTotal (bool $withTotal)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Expandable
	withExpand (string $expand)
Public Member Functions inherited from Commercetools\Api\Client\Resource\Sortable
	withSort (string $sort)

Additional Inherited Members
Protected Member Functions inherited from Commercetools\Client\ApiRequest
	ensureHeader (array $headers, string $header, $defaultValue)
	responseData (ResponseInterface $response)

Detailed Description

@psalm-suppress PropertyNotSetInConstructor @template-implements Query<ByProjectKeyCustomObjectsByContainerGet> @template-implements Paging<ByProjectKeyCustomObjectsByContainerGet> @template-implements Expandable<ByProjectKeyCustomObjectsByContainerGet> @template-implements Sortable<ByProjectKeyCustomObjectsByContainerGet> @template-implements Expandable<ByProjectKeyCustomObjectsByContainerGet> @template-implements Errorable<ByProjectKeyCustomObjectsByContainerGet> @template-implements Deprecatable200<ByProjectKeyCustomObjectsByContainerGet>

Definition at line 41 of file ByProjectKeyCustomObjectsByContainerGet.php.

Constructor & Destructor Documentation

__construct()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::__construct	(	string	$projectKey,
		string	$container,
			$body = null,
		array	$headers = [],
		ClientInterface	$client = null
	)

Parameters

?object|array|string

$body @psalm-param array<string, scalar|scalar[]> $headers

Definition at line 47 of file ByProjectKeyCustomObjectsByContainerGet.php.

Member Function Documentation

execute()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::execute	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

null|T|CustomObjectPagedQueryResponse|ErrorResponse|JsonObject

Definition at line 109 of file ByProjectKeyCustomObjectsByContainerGet.php.

executeAsync()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::executeAsync	(	array	$options = [],
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

PromiseInterface

Definition at line 132 of file ByProjectKeyCustomObjectsByContainerGet.php.

mapFromResponse()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::mapFromResponse	(	?ResponseInterface	$response,
		string	$resultType = null
	)

@template T of JsonObject @psalm-param ?class-string<T> $resultType

Returns

CustomObjectPagedQueryResponse|ErrorResponse|JsonObject|T|null

Definition at line 58 of file ByProjectKeyCustomObjectsByContainerGet.php.

withExpand()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withExpand

(

$expand

)

@psalm-param scalar|scalar[] $expand

Definition at line 173 of file ByProjectKeyCustomObjectsByContainerGet.php.

withLimit()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withLimit

(

$limit

)

@psalm-param scalar|scalar[] $limit

Definition at line 191 of file ByProjectKeyCustomObjectsByContainerGet.php.

withOffset()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withOffset

(

$offset

)

@psalm-param scalar|scalar[] $offset

Definition at line 200 of file ByProjectKeyCustomObjectsByContainerGet.php.

withPredicateVar()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withPredicateVar	(	string	$varName,
			$predicateVar
	)

@psalm-param string $varName @psalm-param scalar|scalar[] $predicateVar

Definition at line 182 of file ByProjectKeyCustomObjectsByContainerGet.php.

withSort()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withSort

(

$sort

)

@psalm-param scalar|scalar[] $sort

Definition at line 155 of file ByProjectKeyCustomObjectsByContainerGet.php.

withWhere()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withWhere

(

$where

)

@psalm-param scalar|scalar[] $where

Definition at line 164 of file ByProjectKeyCustomObjectsByContainerGet.php.

withWithTotal()

Commercetools\Api\Client\Resource\ByProjectKeyCustomObjectsByContainerGet::withWithTotal

(

$withTotal

)

@psalm-param scalar|scalar[] $withTotal

Definition at line 209 of file ByProjectKeyCustomObjectsByContainerGet.php.

---

The documentation for this class was generated from the following file:

• lib/commercetools-api/src/Client/Resource/ByProjectKeyCustomObjectsByContainerGet.php