ResourceLockComponentLockForPathParams.onUnlockRequested method

ResourceLockComponentLockForPathParams › onUnlockRequested

When provided, this callback is invoked when an unlock of the lock is requested — i.e. when the lock's ResourceLockComponentLockForPathParams.abortController is aborted (by the indicator's "Unlock" menu, the "Unlock active note" command, ResourceLockComponent.requestUnlockForPath, or handleExternalMutation). Use it to clear consumer-side state that shadows the lock (e.g. a pending-operation buffer or a notice) without hand-wiring an abort listener. Fires at most once.

Signature:

onUnlockRequested(this: void): void

Parameters:

Parameter	Type	Description
this	void

Returns: void