useUnlock

useUnlock is a low-level Enterprise EditionReact Admin Enterprise Edition icon hook that returns a callback to call dataProvider.unlock(), leveraging react-query’s useMutation.

Usage

import { useUnlock } from '@react-admin/ra-realtime';

const [unlock, { isLoading, error }] = useUnlock(
    resource,
    { id, identity, meta },
    options
);

Parameters

The first parameter is a resource string (e.g. 'posts').

The second is a payload - an object with the following properties:

  • id: the record id (e.g. 123)
  • identity: an identifier (string or number) corresponding to the identity of the locker (e.g. 'julien'). This usually comes from authProvider.getIdentity()
  • meta: an object that will be forwarded to the dataProvider (optional)

The optional options argument is passed to react-query’s useMutation hook.