public function FileApi::getList in TMGMT Translator Smartling 8.3

Same name and namespace in other branches

1. 8.4 vendor/smartling/api-sdk-php/src/File/FileApi.php \Smartling\File\FileApi::getList()
2. 8.2 api-sdk-php/src/File/FileApi.php \Smartling\File\FileApi::getList()
3. 8.2 vendor/smartling/api-sdk-php/src/File/FileApi.php \Smartling\File\FileApi::getList()

Lists recently uploaded files. Returns a maximum of 500 files.

Parameters

ListFilesParameters $params: (optional) An associative array of additional options, with the following elements:

• 'uriMask': Returns only files with a URI containing a given string. Case is ignored and % is a wildcard. For example, the value .js%n will match strings.json and STRINGS.JSON but not json.strings.
• 'fileTypes': Identifiers: android, ios, gettext, html, javaProperties, yaml, xliff, xml, json, docx, pptx, xlsx, idml, qt, resx, plaintext, cvs. File types are combined using the logical "OR".
• 'lastUploadedAfter': Returns all files uploaded after the specified date.
• 'lastUploadedBefore': Returns all files uploaded before the specified date.
• 'offset': For result set returns, the offset is a number indicating the distance from the beginning of the list; for example, for a result set of "50" files, you can set the offset at 10 to return files 10 - 50.
• 'limit': For result set returns, limits the number of files returned; for example, for a result set of 50 files, a limit of "10" would return files 0 - 10.

Return value

array List of files objects.

Throws

\Smartling\Exceptions\SmartlingApiException

See also

http://docs.smartling.com/pages/API/FileAPI/List/

File

vendor/smartling/api-sdk-php/src/File/FileApi.php, line 234

Class

FileApi

Class FileApi

Namespace

Smartling\File

Code

public function getList(ListFilesParameters $params = null) {
  $params = is_null($params) ? [] : $params
    ->exportToArray();
  $requestData = $this
    ->getDefaultRequestData('query', $params);
  return $this
    ->sendRequest('files/list', $requestData, self::HTTP_METHOD_GET);
}