[comment]: # translation:outdated

[comment]: # ({c165c37a-c165c37a})
# > Screen object

The following objects are directly related to the `screen` API.

[comment]: # ({/c165c37a-c165c37a})

[comment]: # ({b7018b57-2e9a0f45})
### Screen

The screen object has the following properties.

|Property|Type|Description|
|--------|----|-----------|
|screenid|string|*(readonly)* ID of the screen.|
|**name**<br>(required)|string|Name of the screen.|
|hsize|integer|Width of the screen.<br><br>Default: 1|
|vsize|integer|Height of the screen.<br><br>Default: 1|
|userid|string|Screen owner user ID.|
|private|integer|Type of screen sharing.<br><br>Possible values:<br>0 - public screen;<br>1 - *(default)* private screen.|

[comment]: # ({/b7018b57-2e9a0f45})

[comment]: # ({0d6322b0-2ee0564e})
### 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**<br>(required)|string|User ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|

[comment]: # ({/0d6322b0-2ee0564e})

[comment]: # ({1974e0b3-ab2af880})
### 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**<br>(required)|string|User group ID.|
|**permission**<br>(required)|integer|Type of permission level.<br><br>Possible values:<br>2 - read only;<br>3 - read-write;|

[comment]: # ({/1974e0b3-ab2af880})
