Backpack client api: add fetch file and get file list #41760
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
sanchitmalhotra126
approved these changes
Jul 27, 2021
Comment on lines
123
to
138
| fetch: function(childPath, callback) { | ||
| this.fetchWithDataType(childPath, callback, 'json'); | ||
| }, | ||
|
|
||
| /** | ||
| * Retrieve a collection. | ||
| * @param {string} childPath The path underneath api_base_url | ||
| * @param {AjaxNodeStyleCallback} callback - Expected result is the requested | ||
| * collection object. | ||
| */ | ||
| fetchWithDataType: function(childPath, callback, dataType) { | ||
| $.ajax({ | ||
| url: this.api_base_url + '/' + childPath, | ||
| type: 'get', | ||
| dataType: 'json' | ||
| dataType: dataType | ||
| }) |
There was a problem hiding this comment.
nit: could keep this as one function, but just have the dataType param default to 'json' if not specified? (e.g. fetch(childPath, callback, dataType = 'json'))
Edit: oh actually I think IE doesn't support default parameters, but we can still do dataType: dataType || 'json' here to keep it one function if desired
| @@ -21,6 +25,38 @@ export default class BackpackClientApi { | |||
| }); | |||
| } | |||
|
|
|||
| fetchFile(filename, onError, onSuccess) { | |||
| if (!this.channelId) { | |||
There was a problem hiding this comment.
nit: potentially just use !this.hasBackpack() for these checks? So that logic can stay contained to hasBackpack if it ever becomes more than just checking channel ID?
There was a problem hiding this comment.
good call, done!
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.
Add fetch a single file and get the list of all filenames api calls to BackpackClientApi. These will be used for importing files from the backpack and checking for name collisions. We call the error callback if these functions are called before the backpack has been initialized. I also added a
hasBackpackfunction to the api which users of the api can use to check if the backpack has been initialized yet. We only initialize the backpack once the user saves at least one file.Links
Testing story
Tested locally and added unit tests.
PR Checklist: