New: Support well-formed file object in show() #328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
tonyjin
commented
Aug 21, 2017
tonyjin
commented
- Partially reverts changes from Chore: Preview.js cleanup and slight refactor #24 and will enable New: Preview file from offline passed file #326
- Adds 'id' to FILE_FIELDS since we use that to validate the file object passed in
tonyjin
commented
Aug 21, 2017
| // a breaking change and should be done with care. Clients that leverage functionality dependent on this format | ||
| // (e.g. Box.Preview.updateFileCache()) will need to be updated if this list is modified. | ||
| const FILE_FIELDS = [ | ||
| 'id', |
There was a problem hiding this comment.
Normally, id is returned with any get files API call. Now, since we also use this list for simple validation of a passed in file object, I'm explicitly adding this so developers cannot pass in a file object without an ID.
tonyjin
force-pushed
the
file-show
branch
2 times, most recently
from
f0a6932
to
3c0a73c
Compare
priyajeet
reviewed
Aug 22, 2017
src/lib/Preview.js
Outdated
| // load the preview | ||
| this.load(fileId); | ||
| // Check if passed in file is a well-formed Box File object | ||
| if (typeof fileIdOrFile === 'object' && !checkFileValid(fileIdOrFile)) { |
There was a problem hiding this comment.
Should move the === object check inside checkFileValid() since it already has a similar null check
There was a problem hiding this comment.
Also, move the checkFileValid check below
priyajeet
reviewed
Aug 22, 2017
src/lib/Preview.js
Outdated
| if (typeof fileIdOrFile === 'string') { | ||
| // Use cached file data if available, otherwise create empty file object | ||
| this.file = this.cache.get(fileIdOrFile) || { id: fileIdOrFile }; | ||
| } else { |
There was a problem hiding this comment.
Make this else if checkValidFile() else throw the error. So that load() function is guarded. Because we use load() function for all internal calls, which eventually may also send a file object eventually.
There was a problem hiding this comment.
Good suggestions, thanks. Updated.
- Partially reverts changes from box#24. - Adds 'id' to FILE_FIELDS since we use that to validate the file object passed in
priyajeet
approved these changes
Aug 22, 2017
pramodsum
added a commit
to JustinHoldstock/box-content-preview
that referenced
this pull request
Jan 25, 2019
https://github.com/box/box-annotations/releases/tag/v3.7.1 * Update Translations (box#328) ([39805b8](box/box-annotations@39805b8)), closes [box#328](box/box-annotations#328) * Chore: Add escape hotkey on AnnotationPopover (box#327) ([e92ec85](box/box-annotations@e92ec85)), closes [box#327](box/box-annotations#327) * Fix: Highlight selection on Surface (box#326) ([6a3b83a](box/box-annotations@6a3b83a)), closes [box#326](box/box-annotations#326) * Fix: Import correct styling for flyout component (box#325) ([14d65f6](box/box-annotations@14d65f6)), closes [box#325](box/box-annotations#325)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.