URL Scheme

Wipe My Screen has a URL scheme for launching the app directly to the wipe screen. This page documents the URL scheme and the parameters it accepts.

method

wipemyscreen://start?method=image|color

Open Wipe My Screen directly to the wipe screen using the inputted method. Choose between color or image.

wipemyscreen://start?color=000000&method=color

Sets the background color of the wipe screen to the supplied hex value (e.g. 00FF00).

wipemyscreen://start?image=https://wipemyscreen.com/images/wipemyscreen-300.png&method=image

Retrieves the remote image and sets it as the wipe screen background image.

NOTE: Only images that can be retrieved using HTTPS are supported.

wipemyscreen://start?authentication=1

Open to the wipe screen and require authentication to exit. The device will prompt with Face ID, Touch ID, or the device passcode.

wipemyscreen://start?instructions=1

Determine whether the wipe screen should display instructions on how to exit. Set the value to either 0 or 1.

The instructions and authentication parameters can be combined with color, image, and method. For instance:

wipemyscreen://start?color=00FF00&method=color&instructions=0&authentication=1

Opening this URL will cause Wipe My Screen to open to a green wipe screen, not show instructions, and require authentication to exit.