Documentation
Table of Contents
> Screen object
The following objects are directly related to the screen API.
Screen
The screen object has the following properties.
| Property | Type | Description |
|---|---|---|
| screenid | string | (readonly) ID of the screen. |
| name (required) |
string | Name of the screen. |
| hsize | integer | Width of the screen. Default: 1 |
| vsize | integer | Height of the screen. Default: 1 |
| userid | string | Screen owner user ID. |
| private | integer | Type of screen sharing. Possible values: 0 - public screen; 1 - (default) private screen. |
Screen user
List of screen permissions based on users. It has the following properties:
| Property | Type | Description |
|---|---|---|
| screenuserid | string | (readonly) ID of the screen user. |
| userid (required) |
string | User ID. |
| permission (required) |
integer | Type of permission level. Possible values: 2 - read only; 3 - read-write; |
Screen user group
List of screen permissions based on user groups. It has the following properties:
| Property | Type | Description |
|---|---|---|
| screenusrgrpid | string | (readonly) ID of the screen user group. |
| usrgrpid (required) |
string | User group ID. |
| permission (required) |
integer | Type of permission level. Possible values: 2 - read only; 3 - read-write; |