Zip List Entries

List the contents of a ZIP file

SDK Method

$file->zipListContents;

Return Object

ZipListEntry

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

try {
  $file = new \Files\Model\File();
  $file->zipListContents();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The ZipListEntry Object

Some of the methods above return a ZipListEntry object. The attributes of this object are listed below.

AttributeDescription
path
string
Entry path inside the ZIP. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
size
int64
Uncompressed size in bytes.