-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
proposal: Cancel assemblies optional #3575
Changes from 7 commits
1775410
808ade1
1b90fbd
551915d
94bc058
aff8523
df9acfd
b251118
c6a297a
5aaa240
49ae0f3
5141d93
be3088a
38c9ed3
834cc1f
c82d0c8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -559,10 +559,6 @@ Retry an upload (after an error, for example). | |
|
||
Retry all uploads (after an error, for example). | ||
|
||
### `uppy.cancelAll()` | ||
|
||
Cancel all uploads, reset progress and remove all files. | ||
|
||
### `uppy.setState(patch)` | ||
|
||
Update Uppy’s internal state. Usually, this method is called internally, but in some cases it might be useful to alter something directly, especially when implementing your own plugins. | ||
|
@@ -673,14 +669,16 @@ uppy.getPlugin('Dashboard').setOptions({ | |
}) | ||
``` | ||
|
||
### `uppy.reset()` | ||
### `uppy.reset()` (alias `uppy.cancelAll()`) | ||
|
||
Stop all uploads in progress and clear file selection, set progress to 0. More or less, it returns things to the way they were before any user input. | ||
|
||
### `uppy.close()` | ||
### `uppy.close({ reason = 'user' })` | ||
|
||
Uninstall all plugins and close down this Uppy instance. Also runs `uppy.reset()` before uninstalling. | ||
|
||
* `reason`: If set to the string `user`, it will also cancel any running Transloadit assemblies. Set to `unmount` to disable this behavior. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be documented in core. Instead, we should explain the possible values of There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I updated the docs |
||
|
||
### `uppy.logout()` | ||
|
||
Calls `provider.logout()` on each remote provider plugin (Google Drive, Instagram, etc). Useful, for example, after your users log out of their account in your app — this will clean things up with Uppy cloud providers as well, for extra security. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this also be added for
uppy.cancelAll
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch