Sometimes it's necessary to stop a user's interatction with an app whilst it is busy. This could be when your app is performing a time-intensive activity, e.g. like sending large payloads to an API. Stopping the user's interaction may help stop your app getting into an invalid state whilst "blocking" background processes operate.

Basic Usage

To use blocking mode from your app, call the setBlocking(true | false) from the app SDK client:

import { useInitialisedDeskproAppClient } from "@deskpro/app-sdk";

export const MyComponent = () => {

  useInitialisedDeskproAppClient((client) => {
	  
		// Enable blocking mode
		client.setBlocking(true);
		
		// Disable blocking mode
		// client.setBlocking(false);
		
	});

  // ...
};
 copy

Enabling blocking mode will render the following screen, blocking user interaction but maintaining the app's running state in the background.