Sidebar
manual:api:reference:screen:exists
Table of Contents
screen.exists
Description
boolean screen.exists(object filter)
This method checks if at least one screen that matches the given filter criteria exists.
This method is deprecated and will be removed in the future. Please use screen.get instead.
Parameters
(object) Criteria to search by.
The following parameters are supported as search criteria.
| Parameter | Type | Description |
|---|---|---|
| name | string/array | Names of the screens. |
| screenid | string/array | IDs of the screens. |
Return values
(boolean) Returns true if at least one screen that matches the given filter criteria exists.
Examples
Checking a screen by name
Check if a screen named “Graphs” already exists.
Request:
{ "jsonrpc": "2.0", "method": "screen.exists", "params": { "name": "Graphs" }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": true, "id": 1 }
Source
CScreen::exists() in frontends/php/include/classes/api/services/CScreen.php.