Browse API 1 documentation
GroveAPI 1preview

grove.uploads.unregister()

Make an upload provider unavailable for new native requests.

Mango 3.1+View Markdown

Make an upload provider unavailable for new native requests.

Signature

ts
grove.uploads.unregister(providerID: string): void

Availability

Headless Root with uploads.provide; the same native registration rules apply as register.

Parameters

Parameter Required Description
providerID Yes Exact local provider identifier previously registered.

Return value

Returns undefined.

Behavior and errors

Removes the handler from this document’s registry and republishes the remaining IDs. An unknown ID has no effect on that registry. This does not uninstall the package, delete credentials, remove manifest metadata, or provide a cancellation signal for a handler already executing. Register again when service configuration becomes usable.

Example

js
grove.uploads.unregister('primary')

See grove.uploads.register().