diff --git a/CHANGELOG.md b/CHANGELOG.md index cc6ca71f..2fc5c30c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 1.19.0 + +- Added `generateRepresentations` option to [`files.getRepresentationContent()`](./docs/files.md#get-representation-content) + ## 1.18.0 - Updated dependencies to resolve potential security issues: diff --git a/docs/files.md b/docs/files.md index ebaac647..25f1e2e0 100644 --- a/docs/files.md +++ b/docs/files.md @@ -1029,6 +1029,18 @@ client.files.getRepresentationInfo('67890', '[pdf][extracted_text]') }); ``` +Setting the `generateRepresentations` option to `true` will automatically poll the status of +all specified representations to generate them. + +```js +client.files.getRepresentationInfo('67890', '[pdf][extracted_text]', { generateRepresentations: true }) + .then(representations => { + // All representations should be generated + // ... + }); +``` + + [get-rep-info]: http://opensource.box.com/box-node-sdk/jsdoc/Files.html#getRepresentationInfo [x-rep-hints]: https://developer.box.com/reference#section-x-rep-hints-header diff --git a/docs/jsdoc/APIRequest.html b/docs/jsdoc/APIRequest.html index d6ae1bd2..ac72ac5e 100644 --- a/docs/jsdoc/APIRequest.html +++ b/docs/jsdoc/APIRequest.html @@ -1327,7 +1327,7 @@
options
Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +
---|---|---|---|---|
generateRepresentations |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + false + + | + + +Set to true to return representation info where all states resolve to success. | +
callback