Skip to content

Commit 20886d7

Browse files
committed
docs: Update Get-ItemState description
1 parent 4e8bc27 commit 20886d7

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

docs/commands/en-US/Get-ItemState.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,11 @@ Get-ItemState [-CamerasOnly] [[-Timeout] <TimeSpan>] [<CommonParameters>]
1919

2020
## DESCRIPTION
2121

22-
Sends a MessageCommunication.ProvideCurrentStateRequest message and returns the response.
22+
The `Get-ItemState` cmdlet sends a "MessageCommunication.ProvideCurrentStateRequest" message and returns the response
23+
from the XProtect Event Server.
2324

24-
The ProvideCurrentStateResponse contains a flat collection of ItemState objects representing the state of all known items in the site.
25-
Each ItemState contains an FQID, and State property.
26-
The FQID.Kind and FQID.ObjectId can be used to determine what type of object the state represents, and the ID of that object.
27-
28-
Most of the time, you will probably only be interested in Camera objects, so you can filter the output with the -CamerasOnly switch.
25+
The `VideoOS.Platform.Messaging.ItemState` objects returned by this command have an `FQID` and `State` property, and
26+
using the `FQID` this command enriches the output by adding the item `Name`, `ItemType`, and `Id` as note properties.
2927

3028
REQUIREMENTS
3129

0 commit comments

Comments
 (0)