Cloudinary\Api\Upload\TagTrait | Cloudinary PHP SDK

trait TagTrait

Trait TagTrait

Properties

ApiClient

$apiClient

Defined in UploadApi class.

Methods

addTagAsync(string $tag, array $publicIds = [], array $options = [])

Adds a tag to the assets specified.

addTag(string $tag, array $publicIds = [], array $options = [])

Adds a tag to the assets specified.

removeTagAsync(string $tag, array|string $publicIds = [], array $options = [])

Removes a tag from the assets specified.

removeTag(string $tag, array|string $publicIds = [], array $options = [])

Removes a tag from the assets specified.

removeAllTagsAsync(array $publicIds = [], array $options = [])

Removes all tags from the assets specified.

removeAllTags(array $publicIds = [], array $options = [])

Removes all tags from the assets specified.

replaceTagAsync(string $tag, array|string $publicIds = [], array $options = [])

Replaces all existing tags on the assets specified with the tag specified.

replaceTag(string $tag, array|string $publicIds = [], array $options = [])

Replaces all existing tags on the assets specified with the tag specified.

Details

`PromiseInterface addTagAsync(string $tag, array $publicIds = [], array $options = [])`

Adds a tag to the assets specified.

This is an asynchronous function.

Parameters

Name	Type	Description
$tag	string	The name of the tag to add.
$publicIds	array	The public IDs of the assets to add the tag to.
$options	array	The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

`ApiResponse addTag(string $tag, array $publicIds = [], array $options = [])`

Adds a tag to the assets specified.

Parameters

Name	Type	Description
$tag	string	The name of the tag to add.
$publicIds	array	The public IDs of the assets to add the tag to.
$options	array	The optional parameters. See the upload API documentation.

Return Value

ApiResponse

`PromiseInterface removeTagAsync(string $tag, array|string $publicIds = [], array $options = [])`

Removes a tag from the assets specified.

This is an asynchronous function.

Parameters

Name	Type	Description
$tag	string	The name of the tag to remove.
$publicIds	array\|string	The public IDs of the assets to remove the tags from.
$options	array	The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

`ApiResponse removeTag(string $tag, array|string $publicIds = [], array $options = [])`

Removes a tag from the assets specified.

Parameters

Name	Type	Description
$tag	string	The name of the tag to remove.
$publicIds	array\|string	The public IDs of the assets to remove the tags from.
$options	array	The optional parameters. See the upload API documentation.

Return Value

ApiResponse

`PromiseInterface removeAllTagsAsync(array $publicIds = [], array $options = [])`

Removes all tags from the assets specified.

This is an asynchronous function.

Parameters

Name	Type	Description
$publicIds	array	The public IDs of the assets to remove all tags from.
$options	array	The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

`ApiResponse removeAllTags(array $publicIds = [], array $options = [])`

Removes all tags from the assets specified.

Parameters

Name	Type	Description
$publicIds	array	The public IDs of the assets to remove all tags from.
$options	array	The optional parameters. See the upload API documentation.

Return Value

ApiResponse

`PromiseInterface replaceTagAsync(string $tag, array|string $publicIds = [], array $options = [])`

Replaces all existing tags on the assets specified with the tag specified.

This is an asynchronous function.

Parameters

Name	Type	Description
$tag	string	The new tag with which to replace the existing tags.
$publicIds	array\|string	The public IDs of the assets to replace the tags of.
$options	array	The optional parameters. See the upload API documentation.

Return Value

PromiseInterface

`ApiResponse replaceTag(string $tag, array|string $publicIds = [], array $options = [])`

Replaces all existing tags on the assets specified with the tag specified.

Parameters

Name	Type	Description
$tag	string	The new tag with which to replace the existing tags.
$publicIds	array\|string	The public IDs of the assets to replace the tags of.
$options	array	The optional parameters. See the upload API documentation.

Return Value

ApiResponse

TagTrait

Properties

Methods

Details

`PromiseInterface addTagAsync(string $tag, array $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`ApiResponse addTag(string $tag, array $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`PromiseInterface removeTagAsync(string $tag, array|string $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`ApiResponse removeTag(string $tag, array|string $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`PromiseInterface removeAllTagsAsync(array $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`ApiResponse removeAllTags(array $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`PromiseInterface replaceTagAsync(string $tag, array|string $publicIds = [], array $options = [])`

Parameters

Return Value

See also

`ApiResponse replaceTag(string $tag, array|string $publicIds = [], array $options = [])`

Parameters

Return Value

See also