Skip to content
ImageKit.io edited this page Jun 23, 2022 · 2 revisions
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

ImageKit\Manage\File

Methods

NameDescription
bulkAddTagsBulk Add Tags
bulkDeleteByFileIdsDelete Bulk Files by File ID API
bulkRemoveAITagsBulk Remove AI Tags
bulkRemoveTagsBulk Remove Tags
copyCopy File API
deleteDelete File API
deleteVersionDelete File Version API
getDetailsGet Details Of file
getFileVersionsGet All Versions Of file
getVersionDetailsGet Version Details Of file
listFileList File API
moveMove File API
renameRename File API
restoreVersionRestore File Version API
updateDetailsUpdate File Details

File::bulkAddTags

Description

publicstaticbulkAddTags (array $fileIds, array $tags, \GuzzleHttpWrapper $resource)

Bulk Add Tags

Parameters

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

Return Values

\Response


File::bulkDeleteByFileIds

Description

publicstaticbulkDeleteByFileIds ( $fileIds, \GuzzleHttpWrapper $resource)

Delete Bulk Files by File ID API

Parameters

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

Return Values

\Response


File::bulkRemoveAITags

Description

publicstaticbulkRemoveAITags (array $fileIds, array $AITags, \GuzzleHttpWrapper $resource)

Bulk Remove AI Tags

Parameters

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

Return Values

\Response


File::bulkRemoveTags

Description

publicstaticbulkRemoveTags (array $fileIds, array $tags, \GuzzleHttpWrapper $resource)

Bulk Remove Tags

Parameters

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

Return Values

\Response


File::copy

Description

publicstaticcopy ( $sourceFilePath, $destinationPath, $includeVersions, \GuzzleHttpWrapper $resource)

Copy File API

Parameters

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

Return Values

\Response


File::delete

Description

publicstaticdelete ( $fileId, \GuzzleHttpWrapper $resource)

Delete File API

Parameters

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

Return Values

\Response


File::deleteVersion

Description

publicstaticdeleteVersion ( $fileId, $versionId, \GuzzleHttpWrapper $resource)

Delete File Version API

Parameters

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

Return Values

\Response


File::getDetails

Description

publicstaticgetDetails (string $fileId, \GuzzleHttpWrapper $resource)

Get Details Of file

Parameters

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

Return Values

\Response


File::getFileVersions

Description

publicstaticgetFileVersions (string $fileId, \GuzzleHttpWrapper $resource)

Get All Versions Of file

Parameters

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

Return Values

\Response


File::getVersionDetails

Description

publicstaticgetVersionDetails (string $fileId, string $versionId, \GuzzleHttpWrapper $resource)

Get Version Details Of file

Parameters

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

Return Values

\Response


File::listFile

Description

publicstaticlistFile (array $parameters, \GuzzleHttpWrapper $resource)

List File API

Parameters

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

Return Values

\Response


File::move

Description

publicstaticmove ( $sourceFilePath, $destinationPath, \GuzzleHttpWrapper $resource)

Move File API

Parameters

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

Return Values

\Response


File::rename

Description

publicstaticrename ( $filePath, $newFileName, $purgeCache, \GuzzleHttpWrapper $resource)

Rename File API

Parameters

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

Return Values

\Response


File::restoreVersion

Description

publicstaticrestoreVersion (\GuzzleHttpWrapper $resource)

Restore File Version API

Parameters

  • (\GuzzleHttpWrapper) $resource

Return Values

\Response


File::updateDetails

Description

publicstaticupdateDetails ( $fileId, $updateData, \GuzzleHttpWrapper $resource)

Update File Details

Parameters

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

Return Values

\Response


Clone this wiki locally