Get-CsPersistentChatEligiblePrincipal

Get-CsPersistentChatEligiblePrincipal
    -Category <String>
    [-Filter <String>]
    [-PersistentChatPoolFqdn <String>]
    [-ResultSize <Int32>]
    [<CommonParameters>]

Get-CsPersistentChatEligiblePrincipal
    -Room <String>
    [-Filter <String>]
    [-PersistentChatPoolFqdn <String>]
    [-Presenters]
    [-ResultSize <Int32>]
    [<CommonParameters>]

The Persistent Chat service provides organizations with messaging and collaboration capabilities similar to those found in Internet discussion forums: users can exchange messages in real-time, yet can also revisit and restart those conversations at any time. Conversations can be based around specific topics, and these conversations can be made available to everyone or to only a selected set of users. Likewise, individual chat rooms can be configured so that anyone can post a message or configured so that only designated presenters can post messages.

Chat categories provide the option of specifying certain users as Creators; that is, users who are allowed to create chat rooms within the category. Likewise, chat rooms provide the option of specifying users as Managers and/or Presenters. In order to be assigned any of these roles, however, the users in question must appear on the AllowedMembers list for the specified category/room. You can retrieve the list of allowed members for a room or category by using the Get-CsPersistentChatRoom cmdlet and the Get-CsPersistentChatCategory cmdlets However, if a security group, OU, or domain has been added to the allowed members list you will not see the names of the users in that security group, OU, or domain. For example, if the security group FinanceManagers is on the allowed list you will not see the names of the users who belong to FinanceManagers; instead, you will only see the name of the group.

To view the names of all the users in that group (as well as the names of all the users on the allowed members list for a category or room) use the Get-CsPersistentChatEligiblePrincipal room instead.

The functions carried out by the Get-CsPersistentChatEligiblePrincipal cmdlet are not available in the Skype for Business Server Control Panel.

Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Category "ITChat"

The command shown in Example 1 returns information about the eligible principals for the Persistent Chat category ITChat.

Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters

In Example 2, information is returned for all the eligible presenters for the chat room HelpDeskChatRoom.

Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters | Where-Object {$_.PersistentChatPrincipalType -ne "user"}

Example 3 is a variation on the command shown in Example 2; in this example, however, information is returned only for Persistent Chat presenters which do not represent user accounts. To do this, the Get-CsPersistentChatEligiblePrincipal cmdlet is first used to return all the presenters for the chat room HelpDeskChatRoom. That collection is then piped to the Where-Object cmdlet, which selects only those presenters where the PersistentChatPrincipalType property is not equal to (-ne) "user".

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.