> Screen object

The following objects are directly related to the screen API.

Screen

The screen object has the following properties.

PropertyTypeDescription
screenidstring(readonly) ID of the screen.
name
(required)		stringName of the screen.
hsizeintegerWidth of the screen.

Default: 1
vsizeintegerHeight of the screen.

Default: 1
useridstringScreen owner user ID.
privateintegerType 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:

PropertyTypeDescription
screenuseridstring(readonly) ID of the screen user.
userid
(required)		stringUser ID.
permission
(required)		integerType 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:

PropertyTypeDescription
screenusrgrpidstring(readonly) ID of the screen user group.
usrgrpid
(required)		stringUser group ID.
permission
(required)		integerType of permission level.

Possible values:
2 - read only;
3 - read-write;