File

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

ImageKit\Manage\File

Methods

Name	Description
bulkAddTags	Bulk Add Tags
bulkDeleteByFileIds	Delete Bulk Files by File ID API
bulkRemoveAITags	Bulk Remove AI Tags
bulkRemoveTags	Bulk Remove Tags
copy	Copy File API
delete	Delete File API
deleteVersion	Delete File Version API
getDetails	Get Details Of file
getFileVersions	Get All Versions Of file
getVersionDetails	Get Version Details Of file
listFile	List File API
move	Move File API
rename	Rename File API
restoreVersion	Restore File Version API
updateDetails	Update File Details

File::bulkAddTags

Description

public static bulkAddTags (array $fileIds, array $tags, \GuzzleHttpWrapper $resource)

Bulk Add Tags

Parameters

• (array) $fileIds
• (array) $tags
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::bulkDeleteByFileIds

Description

public static bulkDeleteByFileIds ( $fileIds, \GuzzleHttpWrapper $resource)

Delete Bulk Files by File ID API

Parameters

• () $fileIds
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::bulkRemoveAITags

Description

public static bulkRemoveAITags (array $fileIds, array $AITags, \GuzzleHttpWrapper $resource)

Bulk Remove AI Tags

Parameters

• (array) $fileIds
• (array) $AITags
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::bulkRemoveTags

Description

public static bulkRemoveTags (array $fileIds, array $tags, \GuzzleHttpWrapper $resource)

Bulk Remove Tags

Parameters

• (array) $fileIds
• (array) $tags
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::copy

Description

public static copy ( $sourceFilePath,  $destinationPath,  $includeVersions, \GuzzleHttpWrapper $resource)

Copy File API

Parameters

• () $sourceFilePath
• () $destinationPath
• () $includeVersions
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::delete

Description

public static delete ( $fileId, \GuzzleHttpWrapper $resource)

Delete File API

Parameters

• () $fileId
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::deleteVersion

Description

public static deleteVersion ( $fileId,  $versionId, \GuzzleHttpWrapper $resource)

Delete File Version API

Parameters

• () $fileId
• () $versionId
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::getDetails

Description

public static getDetails (string $fileId, \GuzzleHttpWrapper $resource)

Get Details Of file

Parameters

• (string) $fileId
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::getFileVersions

Description

public static getFileVersions (string $fileId, \GuzzleHttpWrapper $resource)

Get All Versions Of file

Parameters

• (string) $fileId
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::getVersionDetails

Description

public static getVersionDetails (string $fileId, string $versionId, \GuzzleHttpWrapper $resource)

Get Version Details Of file

Parameters

• (string) $fileId
• (string) $versionId
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::listFile

Description

public static listFile (array $parameters, \GuzzleHttpWrapper $resource)

List File API

Parameters

• (array) $parameters
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::move

Description

public static move ( $sourceFilePath,  $destinationPath, \GuzzleHttpWrapper $resource)

Move File API

Parameters

• () $sourceFilePath
• () $destinationPath
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::rename

Description

public static rename ( $filePath,  $newFileName,  $purgeCache, \GuzzleHttpWrapper $resource)

Rename File API

Parameters

• () $filePath
• () $newFileName
• () $purgeCache
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::restoreVersion

Description

public static restoreVersion (\GuzzleHttpWrapper $resource)

Restore File Version API

Parameters

• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---

File::updateDetails

Description

public static updateDetails ( $fileId,  $updateData, \GuzzleHttpWrapper $resource)

Update File Details

Parameters

• () $fileId
• () $updateData
• (\GuzzleHttpWrapper) $resource

Return Values

\Response

---